commit 9b55e8b6831f5ea04a6175134ea669ceedacc3e3 Author: callmeyan Date: Tue Dec 12 16:53:12 2023 +0800 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4fcc33f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/node_modules/ +bin \ No newline at end of file diff --git a/.vs/ProjectEvaluation/testwordaddin1.metadata.v7.bin b/.vs/ProjectEvaluation/testwordaddin1.metadata.v7.bin new file mode 100644 index 0000000..f162594 Binary files /dev/null and b/.vs/ProjectEvaluation/testwordaddin1.metadata.v7.bin differ diff --git a/.vs/ProjectEvaluation/testwordaddin1.projects.v7.bin b/.vs/ProjectEvaluation/testwordaddin1.projects.v7.bin new file mode 100644 index 0000000..33e58a2 Binary files /dev/null and b/.vs/ProjectEvaluation/testwordaddin1.projects.v7.bin differ diff --git a/.vs/TestWordAddIn1/DesignTimeBuild/.dtbcache.v2 b/.vs/TestWordAddIn1/DesignTimeBuild/.dtbcache.v2 new file mode 100644 index 0000000..d082c22 Binary files /dev/null and b/.vs/TestWordAddIn1/DesignTimeBuild/.dtbcache.v2 differ diff --git a/.vs/TestWordAddIn1/FileContentIndex/2708d09d-9c65-4514-97ce-95be538e9aaf.vsidx b/.vs/TestWordAddIn1/FileContentIndex/2708d09d-9c65-4514-97ce-95be538e9aaf.vsidx new file mode 100644 index 0000000..5109a38 Binary files /dev/null and b/.vs/TestWordAddIn1/FileContentIndex/2708d09d-9c65-4514-97ce-95be538e9aaf.vsidx differ diff --git a/.vs/TestWordAddIn1/FileContentIndex/37a3e652-fab8-4770-b9ce-677c07f6c074.vsidx b/.vs/TestWordAddIn1/FileContentIndex/37a3e652-fab8-4770-b9ce-677c07f6c074.vsidx new file mode 100644 index 0000000..7e6224a Binary files /dev/null and b/.vs/TestWordAddIn1/FileContentIndex/37a3e652-fab8-4770-b9ce-677c07f6c074.vsidx differ diff --git a/.vs/TestWordAddIn1/FileContentIndex/5d3f09e2-4399-4b5d-94b2-ef193f4fe110.vsidx b/.vs/TestWordAddIn1/FileContentIndex/5d3f09e2-4399-4b5d-94b2-ef193f4fe110.vsidx new file mode 100644 index 0000000..283f1cd Binary files /dev/null and b/.vs/TestWordAddIn1/FileContentIndex/5d3f09e2-4399-4b5d-94b2-ef193f4fe110.vsidx differ diff --git a/.vs/TestWordAddIn1/FileContentIndex/7cd4d89c-8a2d-470f-8f40-0d39afdf0652.vsidx b/.vs/TestWordAddIn1/FileContentIndex/7cd4d89c-8a2d-470f-8f40-0d39afdf0652.vsidx new file mode 100644 index 0000000..f44c56f Binary files /dev/null and b/.vs/TestWordAddIn1/FileContentIndex/7cd4d89c-8a2d-470f-8f40-0d39afdf0652.vsidx differ diff --git a/.vs/TestWordAddIn1/FileContentIndex/f3a19e2b-2be2-43e5-8968-848d28db862e.vsidx b/.vs/TestWordAddIn1/FileContentIndex/f3a19e2b-2be2-43e5-8968-848d28db862e.vsidx new file mode 100644 index 0000000..9fcb59d Binary files /dev/null and b/.vs/TestWordAddIn1/FileContentIndex/f3a19e2b-2be2-43e5-8968-848d28db862e.vsidx differ diff --git a/.vs/TestWordAddIn1/v17/.futdcache.v2 b/.vs/TestWordAddIn1/v17/.futdcache.v2 new file mode 100644 index 0000000..8392c04 Binary files /dev/null and b/.vs/TestWordAddIn1/v17/.futdcache.v2 differ diff --git a/.vs/TestWordAddIn1/v17/.suo b/.vs/TestWordAddIn1/v17/.suo new file mode 100644 index 0000000..d52f0ee Binary files /dev/null and b/.vs/TestWordAddIn1/v17/.suo differ diff --git a/TestWordAddIn1.sln b/TestWordAddIn1.sln new file mode 100644 index 0000000..58ab341 --- /dev/null +++ b/TestWordAddIn1.sln @@ -0,0 +1,37 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.33516.290 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestWordAddIn1", "TestWordAddIn1\TestWordAddIn1.csproj", "{E12FB108-CC54-49E3-B606-872B9805F9FA}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Webview2WinFormsApp", "Webview2WinFormsApp\Webview2WinFormsApp.csproj", "{283CE9EF-73B6-478A-B177-1B9174220C35}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UtilLib", "UtilLib\UtilLib.csproj", "{724D79C5-93B5-4BD7-9964-A05CCEFD3BFA}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {E12FB108-CC54-49E3-B606-872B9805F9FA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E12FB108-CC54-49E3-B606-872B9805F9FA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E12FB108-CC54-49E3-B606-872B9805F9FA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E12FB108-CC54-49E3-B606-872B9805F9FA}.Release|Any CPU.Build.0 = Release|Any CPU + {283CE9EF-73B6-478A-B177-1B9174220C35}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {283CE9EF-73B6-478A-B177-1B9174220C35}.Debug|Any CPU.Build.0 = Debug|Any CPU + {283CE9EF-73B6-478A-B177-1B9174220C35}.Release|Any CPU.ActiveCfg = Release|Any CPU + {283CE9EF-73B6-478A-B177-1B9174220C35}.Release|Any CPU.Build.0 = Release|Any CPU + {724D79C5-93B5-4BD7-9964-A05CCEFD3BFA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {724D79C5-93B5-4BD7-9964-A05CCEFD3BFA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {724D79C5-93B5-4BD7-9964-A05CCEFD3BFA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {724D79C5-93B5-4BD7-9964-A05CCEFD3BFA}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {7C87838C-07BB-41AF-9F47-1F995065934E} + EndGlobalSection +EndGlobal diff --git a/TestWordAddIn1/AppConfig.cs b/TestWordAddIn1/AppConfig.cs new file mode 100644 index 0000000..c94b039 --- /dev/null +++ b/TestWordAddIn1/AppConfig.cs @@ -0,0 +1,13 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace TestWordAddIn1 +{ + public class AppConfig + { + public static readonly string PanelName = "校对王"; + } +} diff --git a/TestWordAddIn1/Bridge.cs b/TestWordAddIn1/Bridge.cs new file mode 100644 index 0000000..2fd5f5b --- /dev/null +++ b/TestWordAddIn1/Bridge.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace TestWordAddIn1 +{ + public class Bridge + { + public void Test() + { + System.Windows.Forms.MessageBox.Show("Test on C# Bridge!"); + } + } +} diff --git a/TestWordAddIn1/Enums.cs b/TestWordAddIn1/Enums.cs new file mode 100644 index 0000000..37f5663 --- /dev/null +++ b/TestWordAddIn1/Enums.cs @@ -0,0 +1,17 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace TestWordAddIn1 +{ + public enum OfficeType + { + Word, + WPS + } + internal class Enums + { + } +} \ No newline at end of file diff --git a/TestWordAddIn1/Form1.Designer.cs b/TestWordAddIn1/Form1.Designer.cs new file mode 100644 index 0000000..895f60a --- /dev/null +++ b/TestWordAddIn1/Form1.Designer.cs @@ -0,0 +1,92 @@ +namespace TestWordAddIn1 +{ + partial class Form1 + { + /// + /// Required designer variable. + /// + private System.ComponentModel.IContainer components = null; + + /// + /// Clean up any resources being used. + /// + /// true if managed resources should be disposed; otherwise, false. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows Form Designer generated code + + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + this.pictureBox1 = new System.Windows.Forms.PictureBox(); + this.panel1 = new System.Windows.Forms.Panel(); + this.button1 = new System.Windows.Forms.Button(); + ((System.ComponentModel.ISupportInitialize)(this.pictureBox1)).BeginInit(); + this.panel1.SuspendLayout(); + this.SuspendLayout(); + // + // pictureBox1 + // + this.pictureBox1.BackgroundImage = global::TestWordAddIn1.Properties.Resources.android_chrome_192x192; + this.pictureBox1.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Center; + this.pictureBox1.Dock = System.Windows.Forms.DockStyle.Top; + this.pictureBox1.Location = new System.Drawing.Point(0, 0); + this.pictureBox1.Name = "pictureBox1"; + this.pictureBox1.Size = new System.Drawing.Size(800, 200); + this.pictureBox1.SizeMode = System.Windows.Forms.PictureBoxSizeMode.AutoSize; + this.pictureBox1.TabIndex = 0; + this.pictureBox1.TabStop = false; + // + // panel1 + // + this.panel1.Controls.Add(this.button1); + this.panel1.Controls.Add(this.pictureBox1); + this.panel1.Dock = System.Windows.Forms.DockStyle.Fill; + this.panel1.Location = new System.Drawing.Point(0, 0); + this.panel1.Name = "panel1"; + this.panel1.Size = new System.Drawing.Size(800, 450); + this.panel1.TabIndex = 1; + // + // button1 + // + this.button1.Font = new System.Drawing.Font("微软雅黑", 24F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(134))); + this.button1.Location = new System.Drawing.Point(307, 206); + this.button1.Name = "button1"; + this.button1.Size = new System.Drawing.Size(181, 62); + this.button1.TabIndex = 1; + this.button1.Text = "button1"; + this.button1.UseVisualStyleBackColor = true; + this.button1.Click += new System.EventHandler(this.button1_Click); + // + // Form1 + // + this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.ClientSize = new System.Drawing.Size(800, 450); + this.Controls.Add(this.panel1); + this.Name = "Form1"; + this.Text = "Form1"; + ((System.ComponentModel.ISupportInitialize)(this.pictureBox1)).EndInit(); + this.panel1.ResumeLayout(false); + this.panel1.PerformLayout(); + this.ResumeLayout(false); + + } + + #endregion + + private System.Windows.Forms.PictureBox pictureBox1; + private System.Windows.Forms.Panel panel1; + private System.Windows.Forms.Button button1; + } +} \ No newline at end of file diff --git a/TestWordAddIn1/Form1.cs b/TestWordAddIn1/Form1.cs new file mode 100644 index 0000000..a1cd892 --- /dev/null +++ b/TestWordAddIn1/Form1.cs @@ -0,0 +1,25 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace TestWordAddIn1 +{ + public partial class Form1 : Form + { + public Form1() + { + InitializeComponent(); + } + + private void button1_Click(object sender, EventArgs e) + { + MessageBox.Show("Test"); + } + } +} diff --git a/TestWordAddIn1/Form1.resx b/TestWordAddIn1/Form1.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/TestWordAddIn1/Form1.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TestWordAddIn1/Http.cs b/TestWordAddIn1/Http.cs new file mode 100644 index 0000000..507722a --- /dev/null +++ b/TestWordAddIn1/Http.cs @@ -0,0 +1,23 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net; +using System.Text; +using System.Threading.Tasks; + +namespace TestWordAddIn1 +{ + internal class Http + { + public static String Get(string url) + { + HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url); + var res = req.GetResponse(); + using (var reader = new StreamReader(res.GetResponseStream())) + { + return reader.ReadToEnd(); + } + } + } +} diff --git a/TestWordAddIn1/ProofreadItem.cs b/TestWordAddIn1/ProofreadItem.cs new file mode 100644 index 0000000..19f16f6 --- /dev/null +++ b/TestWordAddIn1/ProofreadItem.cs @@ -0,0 +1,145 @@ +using Microsoft.Office.Interop.Word; +using System; +using System.Drawing; +using System.Windows.Forms; +using UtilLib; + +namespace TestWordAddIn1 +{ + public partial class ProofreadItem : UserControl + { + + private readonly Color BG_NORMAL = Color.WhiteSmoke; + private readonly Color BG_HOVER = Color.AliceBlue; + private readonly Color BG_ACTIVE = Color.AliceBlue; + private DiffItem diffItem; + private int currentStart; + private Document document; + private Bookmark bookmark; + private bool processed = false; + + public ProofreadItem() + { + InitializeComponent(); + this.BackColor = BG_NORMAL; + this.document = Globals.ThisAddIn.Application.ActiveDocument; + } + + private void ProofreadItem_MouseEnter(object sender, EventArgs e) + { + this.BackColor = BG_HOVER; + Console.WriteLine("ProofreadItem_MouseEnter"); + } + + private void ProofreadItem_MouseLeave(object sender, EventArgs e) + { + this.BackColor = BG_NORMAL; + Console.WriteLine("ProofreadItem_MouseLeave"); + } + + private void ProofreadItem_Click(object sender, EventArgs e) + { + this.BackColor = BG_ACTIVE; + Console.WriteLine("ProofreadItem_Click"); + } + private void AddBookmark(Color color) + { + int rangeStart = this.currentStart + this.diffItem.Start, + rangeEnd = this.currentStart + this.diffItem.End; + + Range r = this.document.Range(rangeStart, rangeEnd); + + this.bookmark = this.document.Bookmarks.Add("mark_" + this.diffItem.Id, r); + if (this.diffItem.Tag != "i") + { + r.Shading.BackgroundPatternColor = (WdColor)ColorTranslator.ToOle(color); + } + } + + public void SetProofreadItem(DiffItem it, int start) + { + this.diffItem = it; + this.currentStart = start; + this.ProcessView(); + + var typeConfig = TypeConfig.Get(it.Type); + type.Text = typeConfig.Text; + type.Visible = false; + var c = Colors.FromHex(typeConfig.Color); + typePanel.BackColor = c; + //if (it.Tag != "i") + //{ + AddBookmark(c); + //} + + if (it.Type == ProofreadType.blackWord + || it.Type == ProofreadType.blackWordBlock + || it.Type == ProofreadType.sensitive) + { + description.Text = "【敏感词】建议查看"; + } + else + { + if (it.Tag == "r") + { + origin.Text = it.Origin + ">" + it.Text; + description.Text = string.Format("【{0}】建议选用“{1}”", typeConfig.Text, it.Text); + } + else if (it.Tag == "i") + { + origin.Text = it.Text + " 新增"; + description.Text = string.Format("【{0}】建议新增", typeConfig.Text); + } + else + { + origin.Text = it.Origin + " 删除"; + description.Text = string.Format("【{0}】建议删除", typeConfig.Text); + } + } + + } + + private void ProcessView() + { + var showBtn = this.diffItem.IsAccept == AcceptEnum.Default; + btnAccept.Visible = showBtn; + btnIgnore.Visible = showBtn; + processStatus.Visible = !showBtn; + if (!showBtn) + { + processStatus.Text = (this.diffItem.IsAccept == AcceptEnum.Accept) ? "已采纳" : "已忽略"; + } + } + + private void ProofreadItem_Load(object sender, EventArgs e) + { + + } + + private void btnIgnore_Click(object sender, EventArgs e) + { + if (this.diffItem.IsAccept != AcceptEnum.Default) return; + this.diffItem.IsAccept = AcceptEnum.Ignore; + this.bookmark.Range.Shading.BackgroundPatternColor = WdColor.wdColorAutomatic; + MessageBox.Show("忽略" + this.currentStart + this.diffItem.Text); + this.ProcessView(); + } + + private void btnAccept_Click(object sender, EventArgs e) + { + if (this.diffItem.IsAccept != AcceptEnum.Default) return; + this.diffItem.IsAccept = AcceptEnum.Accept; + var rng = this.bookmark.Range; + rng.Shading.BackgroundPatternColor = WdColor.wdColorAutomatic; + if (this.diffItem.Tag == "d") + { + rng.Delete(); + } + else + { + rng.Text = this.diffItem.Text; + } + this.ProcessView(); + } + } +} diff --git a/TestWordAddIn1/ProofreadItem.designer.cs b/TestWordAddIn1/ProofreadItem.designer.cs new file mode 100644 index 0000000..5840104 --- /dev/null +++ b/TestWordAddIn1/ProofreadItem.designer.cs @@ -0,0 +1,147 @@ +using System.Drawing; +using System.Windows.Forms; + +namespace TestWordAddIn1 +{ + partial class ProofreadItem + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源，为 true；否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region 组件设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + this.origin = new System.Windows.Forms.Label(); + this.type = new System.Windows.Forms.Label(); + this.description = new System.Windows.Forms.Label(); + this.btnAccept = new System.Windows.Forms.Button(); + this.btnIgnore = new System.Windows.Forms.Button(); + this.typePanel = new System.Windows.Forms.Panel(); + this.processStatus = new System.Windows.Forms.Label(); + this.SuspendLayout(); + // + // origin + // + this.origin.AutoSize = true; + this.origin.Font = new System.Drawing.Font("微软雅黑", 10.5F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(134))); + this.origin.Location = new System.Drawing.Point(18, 10); + this.origin.Name = "origin"; + this.origin.Size = new System.Drawing.Size(49, 20); + this.origin.TabIndex = 0; + this.origin.Text = "origin"; + // + // type + // + this.type.AutoSize = true; + this.type.Font = new System.Drawing.Font("微软雅黑", 10.5F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(134))); + this.type.Location = new System.Drawing.Point(69, 11); + this.type.Name = "type"; + this.type.Size = new System.Drawing.Size(38, 20); + this.type.TabIndex = 1; + this.type.Text = "type"; + // + // description + // + this.description.AutoSize = true; + this.description.Font = new System.Drawing.Font("微软雅黑", 10.5F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(134))); + this.description.Location = new System.Drawing.Point(12, 36); + this.description.Name = "description"; + this.description.Size = new System.Drawing.Size(84, 20); + this.description.TabIndex = 2; + this.description.Text = "description"; + // + // btnAccept + // + this.btnAccept.BackgroundImage = global::TestWordAddIn1.Properties.Resources.check; + this.btnAccept.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Stretch; + this.btnAccept.Cursor = System.Windows.Forms.Cursors.Hand; + this.btnAccept.Location = new System.Drawing.Point(222, 13); + this.btnAccept.Margin = new System.Windows.Forms.Padding(3, 2, 3, 2); + this.btnAccept.Name = "btnAccept"; + this.btnAccept.Size = new System.Drawing.Size(26, 26); + this.btnAccept.TabIndex = 3; + this.btnAccept.UseVisualStyleBackColor = true; + this.btnAccept.Click += new System.EventHandler(this.btnAccept_Click); + // + // btnIgnore + // + this.btnIgnore.BackgroundImage = global::TestWordAddIn1.Properties.Resources.minus_bold; + this.btnIgnore.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Stretch; + this.btnIgnore.Cursor = System.Windows.Forms.Cursors.Hand; + this.btnIgnore.Location = new System.Drawing.Point(258, 13); + this.btnIgnore.Margin = new System.Windows.Forms.Padding(3, 2, 3, 2); + this.btnIgnore.Name = "btnIgnore"; + this.btnIgnore.Size = new System.Drawing.Size(26, 26); + this.btnIgnore.TabIndex = 4; + this.btnIgnore.UseVisualStyleBackColor = true; + this.btnIgnore.Click += new System.EventHandler(this.btnIgnore_Click); + // + // typePanel + // + this.typePanel.BackColor = System.Drawing.Color.Black; + this.typePanel.Location = new System.Drawing.Point(0, 0); + this.typePanel.Name = "typePanel"; + this.typePanel.Size = new System.Drawing.Size(4, 70); + this.typePanel.TabIndex = 5; + // + // processStatus + // + this.processStatus.AutoSize = true; + this.processStatus.Font = new System.Drawing.Font("微软雅黑", 10.5F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(134))); + this.processStatus.Location = new System.Drawing.Point(222, 18); + this.processStatus.Name = "processStatus"; + this.processStatus.Size = new System.Drawing.Size(50, 20); + this.processStatus.TabIndex = 6; + this.processStatus.Text = "label1"; + // + // ProofreadItem + // + this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.BackColor = System.Drawing.Color.WhiteSmoke; + this.Controls.Add(this.processStatus); + this.Controls.Add(this.typePanel); + this.Controls.Add(this.btnIgnore); + this.Controls.Add(this.btnAccept); + this.Controls.Add(this.description); + this.Controls.Add(this.type); + this.Controls.Add(this.origin); + this.Margin = new System.Windows.Forms.Padding(3, 2, 3, 2); + this.Name = "ProofreadItem"; + this.Size = new System.Drawing.Size(300, 70); + this.ResumeLayout(false); + this.PerformLayout(); + + } + + #endregion + + private Label origin; + private Label type; + private Label description; + private Button btnAccept; + private Button btnIgnore; + private Panel typePanel; + private Label processStatus; + } +} diff --git a/TestWordAddIn1/ProofreadItem.resx b/TestWordAddIn1/ProofreadItem.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/TestWordAddIn1/ProofreadItem.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TestWordAddIn1/ProofreadPanel.Designer.cs b/TestWordAddIn1/ProofreadPanel.Designer.cs new file mode 100644 index 0000000..7772af7 --- /dev/null +++ b/TestWordAddIn1/ProofreadPanel.Designer.cs @@ -0,0 +1,79 @@ +namespace TestWordAddIn1 +{ + partial class ProofreadPanel + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源，为 true；否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region 组件设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + this.button1 = new System.Windows.Forms.Button(); + this.panel1 = new System.Windows.Forms.Panel(); + this.SuspendLayout(); + // + // button1 + // + this.button1.BackColor = System.Drawing.SystemColors.HotTrack; + this.button1.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.button1.ForeColor = System.Drawing.Color.White; + this.button1.ImageAlign = System.Drawing.ContentAlignment.MiddleLeft; + this.button1.Location = new System.Drawing.Point(16, 14); + this.button1.Name = "button1"; + this.button1.Size = new System.Drawing.Size(117, 31); + this.button1.TabIndex = 0; + this.button1.Text = "开始校对"; + this.button1.UseVisualStyleBackColor = false; + this.button1.Click += new System.EventHandler(this.button1_Click); + // + // panel1 + // + this.panel1.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.panel1.AutoScroll = true; + this.panel1.Location = new System.Drawing.Point(16, 61); + this.panel1.Name = "panel1"; + this.panel1.Size = new System.Drawing.Size(304, 606); + this.panel1.TabIndex = 1; + // + // ProofreadPanel + // + this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.BackColor = System.Drawing.Color.White; + this.Controls.Add(this.panel1); + this.Controls.Add(this.button1); + this.Name = "ProofreadPanel"; + this.Size = new System.Drawing.Size(340, 686); + this.Load += new System.EventHandler(this.ProofreadPanel_Load); + this.ResumeLayout(false); + + } + + #endregion + + private System.Windows.Forms.Button button1; + private System.Windows.Forms.Panel panel1; + } +} diff --git a/TestWordAddIn1/ProofreadPanel.cs b/TestWordAddIn1/ProofreadPanel.cs new file mode 100644 index 0000000..cd0ce4b --- /dev/null +++ b/TestWordAddIn1/ProofreadPanel.cs @@ -0,0 +1,131 @@ +using Microsoft.Office.Interop.Word; +using Microsoft.Web.WebView2.Core; +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Reflection; +using System.Runtime.ConstrainedExecution; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using UtilLib; +using static System.Windows.Forms.VisualStyles.VisualStyleElement.Header; + +namespace TestWordAddIn1 +{ + public partial class ProofreadPanel : UserControl + { + private CoreWebView2Environment env; + + private readonly int ItemHeight = 75; + private readonly List Items = new List(); + public ProofreadPanel() + { + InitializeComponent(); + } + + private void ProofreadPanel_Load(object sender, EventArgs e) + { + //InitWebview(); + } + public void SendMessage(string action, object data) + { + //string json = JsonConvert.SerializeObject(new WebActionMessage(action, data)); + //webView21.CoreWebView2.PostWebMessageAsJson(json); + } + + //public async void InitWebview() + //{ + //if (env == null) + //{ + // // 自定义环境位置 + // env = await CoreWebView2Environment.CreateAsync(null, Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "/web/user_data"); + // webView21.CoreWebView2InitializationCompleted += WebView21_CoreWebView2InitializationCompleted; + // await webView21.EnsureCoreWebView2Async(env); + //} + //webView21.Source = new Uri(AppDomain.CurrentDomain.BaseDirectory + "\\web\\index.html"); + //// + //webView21.CoreWebView2.AddHostObjectToScript("bridge", new Bridge()); + //} + + private void WebView21_CoreWebView2InitializationCompleted(object sender, CoreWebView2InitializationCompletedEventArgs e) + { + + } + + private void webView21_Click(object sender, EventArgs e) + { + + } + + + private void button1_Click(object sender, EventArgs e) + { + var app = Globals.ThisAddIn.Application; + var doc = app.ActiveDocument; + var content = doc.Content.Text.Trim(); + if (content.Length > 0) + { + if (MessageBox.Show("将会清空文档内容并加载示例内容,确定继续操作?", "提示", MessageBoxButtons.OKCancel, MessageBoxIcon.Question) != DialogResult.OK) + { + return; + } + // doc.Select(); + var rng = doc.Range(0, content.Length); + rng.Delete(); + } + var result = API.GetProofreadResult(); + if (result == null) + { + MessageBox.Show("加载数据失败,请重试"); + return; + } + var cur = app.Selection; + if (app.Options.Overtype) + { + // 禁用 + app.Options.Overtype = false; + } + if (cur.Type != WdSelectionType.wdSelectionIP) + { + MessageBox.Show("异常"); + return; + } + InitDocument(result); + } + + private void InitDocument(ProofreadResult result) + { + var app = Globals.ThisAddIn.Application; + var cur = app.Selection; + var doc = app.ActiveDocument; + int index = 0; + foreach (var correct in result.CorrectedSet) + { + cur.TypeText(correct.Insert); + var rng = cur.Range; + if (correct.Diffs != null) + { + foreach (var it in correct.Diffs) + { + ProofreadItem item = new ProofreadItem(); + item.SetProofreadItem(it, correct.Offset); + Items.Add(item); + if (it.Tag == "d") + { + var curg = doc.Range(correct.Offset + it.Start, correct.Offset + it.End); + // 设置玄宗效果 + } + item.Location = new System.Drawing.Point(10, (ItemHeight + 10) * index); + panel1.Controls.Add(item); + index++; + } + } + } + } + } +} diff --git a/TestWordAddIn1/ProofreadPanel.resx b/TestWordAddIn1/ProofreadPanel.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/TestWordAddIn1/ProofreadPanel.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TestWordAddIn1/Properties/AssemblyInfo.cs b/TestWordAddIn1/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..0322421 --- /dev/null +++ b/TestWordAddIn1/Properties/AssemblyInfo.cs @@ -0,0 +1,38 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using System.Security; + +// 有关程序集的一般信息由以下 +// 控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("TestWordAddIn1")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("TestWordAddIn1")] +[assembly: AssemblyCopyright("Copyright © 2023")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +//将 ComVisible 设置为 false 将使此程序集中的类型 +//对 COM 组件不可见。 如果需要从 COM 访问此程序集中的类型， +//请将此类型的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开，则下列 GUID 用于类型库的 ID +[assembly: Guid("1fa7f1e1-a05f-4129-a40d-62134d43270d")] + +// 程序集的版本信息由下列四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +//可以指定所有这些值，也可以使用“生成号”和“修订号”的默认值， +// 方法是按如下所示使用“*”: : +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] + diff --git a/TestWordAddIn1/Properties/Resources.Designer.cs b/TestWordAddIn1/Properties/Resources.Designer.cs new file mode 100644 index 0000000..f9098ea --- /dev/null +++ b/TestWordAddIn1/Properties/Resources.Designer.cs @@ -0,0 +1,123 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本:4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为，并且如果 +// 重新生成代码，这些更改将会丢失。 +// +//------------------------------------------------------------------------------ + +namespace TestWordAddIn1.Properties { + using System; + + + /// + /// 一个强类型的资源类，用于查找本地化的字符串等。 + /// + // 此类是由 StronglyTypedResourceBuilder + // 类通过类似于 ResGen 或 Visual Studio 的工具自动生成的。 + // 若要添加或移除成员，请编辑 .ResX 文件，然后重新运行 ResGen + // (以 /str 作为命令选项)，或重新生成 VS 项目。 + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() { + } + + /// + /// 返回此类使用的缓存的 ResourceManager 实例。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("TestWordAddIn1.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// 重写当前线程的 CurrentUICulture 属性，对 + /// 使用此强类型资源类的所有资源查找执行重写。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap android_chrome_192x192 { + get { + object obj = ResourceManager.GetObject("android-chrome-192x192", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap check { + get { + object obj = ResourceManager.GetObject("check", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap favicon { + get { + object obj = ResourceManager.GetObject("favicon", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap minus_bold { + get { + object obj = ResourceManager.GetObject("minus-bold", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap search_check { + get { + object obj = ResourceManager.GetObject("search-check", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap search_proofread { + get { + object obj = ResourceManager.GetObject("search-proofread", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + } +} diff --git a/TestWordAddIn1/Properties/Resources.resx b/TestWordAddIn1/Properties/Resources.resx new file mode 100644 index 0000000..b98cb4e --- /dev/null +++ b/TestWordAddIn1/Properties/Resources.resx @@ -0,0 +1,139 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + + ..\Resources\search-proofread.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\minus-bold.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\favicon.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\check.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\android-chrome-192x192.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\search-check.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + \ No newline at end of file diff --git a/TestWordAddIn1/Properties/Settings.Designer.cs b/TestWordAddIn1/Properties/Settings.Designer.cs new file mode 100644 index 0000000..096e228 --- /dev/null +++ b/TestWordAddIn1/Properties/Settings.Designer.cs @@ -0,0 +1,26 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace TestWordAddIn1.Properties { + + + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "17.0.0.0")] + internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase { + + private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); + + public static Settings Default { + get { + return defaultInstance; + } + } + } +} diff --git a/TestWordAddIn1/Properties/Settings.settings b/TestWordAddIn1/Properties/Settings.settings new file mode 100644 index 0000000..3964565 --- /dev/null +++ b/TestWordAddIn1/Properties/Settings.settings @@ -0,0 +1,7 @@ + + + + + + + diff --git a/TestWordAddIn1/Resources/android-chrome-192x192.png b/TestWordAddIn1/Resources/android-chrome-192x192.png new file mode 100644 index 0000000..419101c Binary files /dev/null and b/TestWordAddIn1/Resources/android-chrome-192x192.png differ diff --git a/TestWordAddIn1/Resources/check.png b/TestWordAddIn1/Resources/check.png new file mode 100644 index 0000000..e6f7e50 Binary files /dev/null and b/TestWordAddIn1/Resources/check.png differ diff --git a/TestWordAddIn1/Resources/favicon.png b/TestWordAddIn1/Resources/favicon.png new file mode 100644 index 0000000..91b4c94 Binary files /dev/null and b/TestWordAddIn1/Resources/favicon.png differ diff --git a/TestWordAddIn1/Resources/minus-bold.png b/TestWordAddIn1/Resources/minus-bold.png new file mode 100644 index 0000000..eabc9b5 Binary files /dev/null and b/TestWordAddIn1/Resources/minus-bold.png differ diff --git a/TestWordAddIn1/Resources/search-check.png b/TestWordAddIn1/Resources/search-check.png new file mode 100644 index 0000000..c3dca6c Binary files /dev/null and b/TestWordAddIn1/Resources/search-check.png differ diff --git a/TestWordAddIn1/Resources/search-proofread.png b/TestWordAddIn1/Resources/search-proofread.png new file mode 100644 index 0000000..c5a4431 Binary files /dev/null and b/TestWordAddIn1/Resources/search-proofread.png differ diff --git a/TestWordAddIn1/Ribbon1.Designer.cs b/TestWordAddIn1/Ribbon1.Designer.cs new file mode 100644 index 0000000..e7c081b --- /dev/null +++ b/TestWordAddIn1/Ribbon1.Designer.cs @@ -0,0 +1,161 @@ +namespace TestWordAddIn1 +{ + partial class Ribbon1 : Microsoft.Office.Tools.Ribbon.RibbonBase + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + public Ribbon1() + : base(Globals.Factory.GetRibbonFactory()) + { + InitializeComponent(); + } + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源，为 true；否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region 组件设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + this.tab1 = this.Factory.CreateRibbonTab(); + this.group1 = this.Factory.CreateRibbonGroup(); + this.button1 = this.Factory.CreateRibbonButton(); + this.btnLoadDocument = this.Factory.CreateRibbonButton(); + this.button3 = this.Factory.CreateRibbonButton(); + this.group2 = this.Factory.CreateRibbonGroup(); + this.btnProofread = this.Factory.CreateRibbonButton(); + this.btnOpenForm = this.Factory.CreateRibbonButton(); + this.button8 = this.Factory.CreateRibbonButton(); + this.button6 = this.Factory.CreateRibbonButton(); + this.tab1.SuspendLayout(); + this.group1.SuspendLayout(); + this.group2.SuspendLayout(); + this.SuspendLayout(); + // + // tab1 + // + this.tab1.ControlId.ControlIdType = Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office; + this.tab1.Groups.Add(this.group1); + this.tab1.Groups.Add(this.group2); + this.tab1.Label = "测试加载项"; + this.tab1.Name = "tab1"; + // + // group1 + // + this.group1.Items.Add(this.button1); + this.group1.Items.Add(this.btnLoadDocument); + this.group1.Items.Add(this.button3); + this.group1.Label = "分组1"; + this.group1.Name = "group1"; + // + // button1 + // + this.button1.Label = "获取当前文本"; + this.button1.Name = "button1"; + this.button1.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button1_Click); + // + // btnLoadDocument + // + this.btnLoadDocument.Label = "加载文档"; + this.btnLoadDocument.Name = "btnLoadDocument"; + this.btnLoadDocument.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button2_Click); + // + // button3 + // + this.button3.Label = "插入"; + this.button3.Name = "button3"; + this.button3.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button3_Click); + // + // group2 + // + this.group2.Items.Add(this.btnProofread); + this.group2.Items.Add(this.btnOpenForm); + this.group2.Items.Add(this.button8); + this.group2.Items.Add(this.button6); + this.group2.Label = "分组2"; + this.group2.Name = "group2"; + // + // btnProofread + // + this.btnProofread.ControlSize = Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge; + this.btnProofread.Image = global::TestWordAddIn1.Properties.Resources.search_proofread; + this.btnProofread.Label = "开始校验"; + this.btnProofread.Name = "btnProofread"; + this.btnProofread.ShowImage = true; + this.btnProofread.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button4_Click); + // + // btnOpenForm + // + this.btnOpenForm.Image = global::TestWordAddIn1.Properties.Resources.favicon; + this.btnOpenForm.Label = "打开原生窗口"; + this.btnOpenForm.Name = "btnOpenForm"; + this.btnOpenForm.ShowImage = true; + this.btnOpenForm.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.btnOpenForm_Click); + // + // button8 + // + this.button8.Label = "测试3"; + this.button8.Name = "button8"; + this.button8.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button8_Click); + // + // button6 + // + this.button6.Label = "保存文档"; + this.button6.Name = "button6"; + this.button6.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.button6_Click); + // + // Ribbon1 + // + this.Name = "Ribbon1"; + this.RibbonType = "Microsoft.Word.Document"; + this.Tabs.Add(this.tab1); + this.Load += new Microsoft.Office.Tools.Ribbon.RibbonUIEventHandler(this.Ribbon1_Load); + this.tab1.ResumeLayout(false); + this.tab1.PerformLayout(); + this.group1.ResumeLayout(false); + this.group1.PerformLayout(); + this.group2.ResumeLayout(false); + this.group2.PerformLayout(); + this.ResumeLayout(false); + + } + + #endregion + + internal Microsoft.Office.Tools.Ribbon.RibbonTab tab1; + internal Microsoft.Office.Tools.Ribbon.RibbonGroup group1; + internal Microsoft.Office.Tools.Ribbon.RibbonButton button1; + internal Microsoft.Office.Tools.Ribbon.RibbonButton btnLoadDocument; + internal Microsoft.Office.Tools.Ribbon.RibbonButton button3; + internal Microsoft.Office.Tools.Ribbon.RibbonGroup group2; + internal Microsoft.Office.Tools.Ribbon.RibbonButton btnProofread; + internal Microsoft.Office.Tools.Ribbon.RibbonButton btnOpenForm; + internal Microsoft.Office.Tools.Ribbon.RibbonButton button8; + internal Microsoft.Office.Tools.Ribbon.RibbonButton button6; + } + + partial class ThisRibbonCollection + { + internal Ribbon1 Ribbon1 + { + get { return this.GetRibbon(); } + } + } +} diff --git a/TestWordAddIn1/Ribbon1.cs b/TestWordAddIn1/Ribbon1.cs new file mode 100644 index 0000000..8b8cbcf --- /dev/null +++ b/TestWordAddIn1/Ribbon1.cs @@ -0,0 +1,175 @@ +using Microsoft.Office.Interop.Word; +using Microsoft.Office.Tools.Ribbon; +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Drawing; +using System.Threading; +using System.Windows.Forms; +using UtilLib; + +namespace TestWordAddIn1 +{ + public partial class Ribbon1 + { + private Microsoft.Office.Interop.Word.Application wordApp; + private Document document; + + private void Ribbon1_Load(object sender, RibbonUIEventArgs e) + { + wordApp = Globals.ThisAddIn.Application; + Console.WriteLine("插件加载完成"); + } + + + private void button1_Click(object sender, RibbonControlEventArgs e) + { + var currentText = wordApp.ActiveDocument.Range().Text; + Debug.WriteLine(currentText); + + System.Windows.Forms.MessageBox.Show("Test:" + currentText); + } + + private void button4_Click(object sender, RibbonControlEventArgs e) + { + // 开始校对 + //var doc = wordApp.ActiveDocument; + //var content = doc.Content.Text.Trim(); + //if (content.Length == 0) + //{ + // System.Windows.Forms.MessageBox.Show("内容为空"); + // return; + //} + Globals.ThisAddIn.SetPanelVisible(true); + } + + void addMarks() + { + document = wordApp.ActiveDocument; + Range rng = document.Range(2, 4); + document.Bookmarks.Add("s24", rng); + + + } + + private void btnOpenForm_Click(object sender, RibbonControlEventArgs e) + { + Form1 f1 = new Form1(); + f1.ShowDialog(); + } + + private void button8_Click(object sender, RibbonControlEventArgs e) + { + //var paragrahs = wordApp.ActiveDocument.Paragraphs; + Document doc = wordApp.ActiveDocument; + object start = 0; + object end = 4; + System.Windows.Forms.MessageBox.Show("选择0,4"); + // 设置区域位置 + Range range = doc.Range(ref start, ref end); // 从 start（索引从0开始）到end前一个字符(不包含end) + range.Select(); // 选中区域 + System.Windows.Forms.MessageBox.Show("即将全选"); + wordApp.ActiveDocument.Select(); // 全选 + var sentences = doc.Sentences; + System.Windows.Forms.MessageBox.Show("句子总计：" + sentences.Count); + if (sentences.Count >= 2) + { + System.Windows.Forms.MessageBox.Show("选中第2个句子"); + var s2 = sentences[2]; // 句子的索引从1开始 + doc.Range(s2.Start, s2.End).Select(); + } + System.Windows.Forms.MessageBox.Show("选择2,5"); + // 设置区域位置 + Range rng = doc.Range(2, 5); + rng.Select(); // + System.Windows.Forms.MessageBox.Show("向后选择多2个字符"); + // 按字符向后移动 + rng.MoveEnd(WdUnits.wdCharacter, 2); + // 字符向前移动 + //rng.MoveStart(WdUnits.wdCharacter, 2); + rng.Select(); + + Thread.Sleep(2000); + // 选择第1段 + rng = doc.Paragraphs[1].Range; + rng.Select(); + Thread.Sleep(1000); + rng.Collapse(WdCollapseDirection.wdCollapseEnd); // 折叠(wdCollapseEnd:向后，wdCollapseStart:向前) + System.Windows.Forms.MessageBox.Show("插入新字符"); + rng.Text = "插入新字符"; + rng.Select(); + } + + private void button6_Click(object sender, RibbonControlEventArgs e) + { + wordApp.ActiveDocument.Save(); + } + + private void button3_Click(object sender, RibbonControlEventArgs e) + { + document = wordApp.ActiveDocument; + var txt = "在文档开头指定一个范围，并插入文本 New Text。\n再说一下这个问题哈"; + Selection cur = wordApp.Selection; + if (cur.Type != WdSelectionType.wdSelectionIP) + { + MessageBox.Show("异常"); + return; + } + cur.TypeText(txt); + AddBookmark(1, 3, "#ff0000"); + AddBookmark(4, 6, "#00ff00"); + + } + private Bookmark AddBookmark(int rangeStart, int rangeEnd,string color) + { + var doc = wordApp.ActiveDocument; + Range r = doc.Range(rangeStart, rangeEnd); + + var mark = doc.Bookmarks.Add("mark_" + rangeStart + "_" + rangeEnd, r); + r.Shading.BackgroundPatternColor = (WdColor)ColorTranslator.ToOle(Colors.FromHex(color)); + return mark; + } + + private ProofreadResult GetSource() + { + + var content = Http.Get("http://test.wx.wm-app.xyz/proofread.json"); + var result = JsonConvert.DeserializeObject>(content); + return result.Data; + } + + // 加载文档 + private void button2_Click(object sender, RibbonControlEventArgs e) + { + document = wordApp.ActiveDocument; + + var cur = wordApp.Selection; + + if (wordApp.Options.Overtype) + { + // 禁用 + wordApp.Options.Overtype = false; + } + if (cur.Type != WdSelectionType.wdSelectionIP) + { + System.Windows.Forms.MessageBox.Show("异常"); + return; + } + var result = GetSource(); + result.CorrectedSet.ForEach(it => + { + cur.TypeText(it.Insert); + }); + + //for (int i = 0; i < 20; i++) + //{ + // cur.TypeText("-->" + i); + // cur.TypeParagraph(); + // Thread.Sleep(1000); + //} + //cur.TypeText("在文档开头指定一个范围，并插入文本 New Text。\n下面的代码示例可用于文档级自定义项。"); + //} + } + } +} diff --git a/TestWordAddIn1/Ribbon1.resx b/TestWordAddIn1/Ribbon1.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/TestWordAddIn1/Ribbon1.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TestWordAddIn1/TestWordAddIn1.csproj b/TestWordAddIn1/TestWordAddIn1.csproj new file mode 100644 index 0000000..6f7fd8e --- /dev/null +++ b/TestWordAddIn1/TestWordAddIn1.csproj @@ -0,0 +1,305 @@ + + + + + {BAA0C2D2-18E2-41B9-852F-F413020CAA33};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + Debug + AnyCPU + {E12FB108-CC54-49E3-B606-872B9805F9FA} + Library + false + TestWordAddIn1 + TestWordAddIn1 + 3 + v4.6.2 + VSTO40 + true + HomeSite + + + + + + False + Microsoft Visual Studio 2010 Tools for Office Runtime %28x86 and x64%29 + true + + + + + Word + + + + true + full + false + bin\Debug\ + false + $(DefineConstants);DEBUG;TRACE + 4 + + + + pdbonly + true + bin\Release\ + false + $(DefineConstants);TRACE + 4 + + + + + + ..\packages\Microsoft.Web.WebView2.1.0.2151.40\lib\net45\Microsoft.Web.WebView2.Core.dll + + + ..\packages\Microsoft.Web.WebView2.1.0.2151.40\lib\net45\Microsoft.Web.WebView2.WinForms.dll + + + ..\packages\Microsoft.Web.WebView2.1.0.2151.40\lib\net45\Microsoft.Web.WebView2.Wpf.dll + + + ..\packages\Newtonsoft.Json.13.0.3\lib\net45\Newtonsoft.Json.dll + + + + + + + + + + + + + + False + + + False + + + False + + + False + + + False + + + + + True + + + + + False + true + + + False + true + + + False + + + + + + + + + Form + + + Form1.cs + + + + UserControl + + + ProofreadItem.cs + + + UserControl + + + ProofreadPanel.cs + + + Code + + + Form1.cs + + + ProofreadItem.cs + + + ProofreadPanel.cs + + + ResXFileCodeGenerator + Resources.Designer.cs + Designer + + + True + Resources.resx + True + + + Ribbon1.cs + + + + SettingsSingleFileGenerator + Settings.Designer.cs + + + True + Settings.settings + + + Component + + + Ribbon1.cs + + + Code + + + + ThisAddIn.cs + + + ThisAddIn.Designer.xml + + + + + + + + + + + + + + + {724d79c5-93b5-4bd7-9964-a05ccefd3bfa} + UtilLib + + + + + + + + Always + + + + 10.0 + $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) + + + true + + + TestWordAddIn1_TemporaryKey.pfx + + + 0618754C31A0C743191F0D2976885003BA3EB202 + + + + + + + + + + + + + + + + + + + + 这台计算机上缺少此项目引用的 NuGet 程序包。使用“NuGet 程序包还原”可下载这些程序包。有关更多信息，请参见 http://go.microsoft.com/fwlink/?LinkID=322105。缺少的文件是 {0}。 + + + + \ No newline at end of file diff --git a/TestWordAddIn1/TestWordAddIn1_TemporaryKey.pfx b/TestWordAddIn1/TestWordAddIn1_TemporaryKey.pfx new file mode 100644 index 0000000..7d40201 Binary files /dev/null and b/TestWordAddIn1/TestWordAddIn1_TemporaryKey.pfx differ diff --git a/TestWordAddIn1/ThisAddIn.Designer.cs b/TestWordAddIn1/ThisAddIn.Designer.cs new file mode 100644 index 0000000..bdc2932 --- /dev/null +++ b/TestWordAddIn1/ThisAddIn.Designer.cs @@ -0,0 +1,237 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#pragma warning disable 414 +namespace TestWordAddIn1 { + + + /// + [Microsoft.VisualStudio.Tools.Applications.Runtime.StartupObjectAttribute(0)] + [global::System.Security.Permissions.PermissionSetAttribute(global::System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] + public sealed partial class ThisAddIn : Microsoft.Office.Tools.AddInBase { + + internal Microsoft.Office.Tools.CustomTaskPaneCollection CustomTaskPanes; + + internal Microsoft.Office.Tools.SmartTagCollection VstoSmartTags; + + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + private global::System.Object missing = global::System.Type.Missing; + + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + internal Microsoft.Office.Interop.Word.Application Application; + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + public ThisAddIn(global::Microsoft.Office.Tools.Word.ApplicationFactory factory, global::System.IServiceProvider serviceProvider) : + base(factory, serviceProvider, "AddIn", "ThisAddIn") { + Globals.Factory = factory; + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + protected override void Initialize() { + base.Initialize(); + this.Application = this.GetHostItem(typeof(Microsoft.Office.Interop.Word.Application), "Application"); + Globals.ThisAddIn = this; + global::System.Windows.Forms.Application.EnableVisualStyles(); + this.InitializeCachedData(); + this.InitializeControls(); + this.InitializeComponents(); + this.InitializeData(); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + protected override void FinishInitialization() { + this.InternalStartup(); + this.OnStartup(); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + protected override void InitializeDataBindings() { + this.BeginInitialization(); + this.BindToData(); + this.EndInitialization(); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void InitializeCachedData() { + if ((this.DataHost == null)) { + return; + } + if (this.DataHost.IsCacheInitialized) { + this.DataHost.FillCachedData(this); + } + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void InitializeData() { + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void BindToData() { + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + private void StartCaching(string MemberName) { + this.DataHost.StartCaching(this, MemberName); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + private void StopCaching(string MemberName) { + this.DataHost.StopCaching(this, MemberName); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + private bool IsCached(string MemberName) { + return this.DataHost.IsCached(this, MemberName); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void BeginInitialization() { + this.BeginInit(); + this.CustomTaskPanes.BeginInit(); + this.VstoSmartTags.BeginInit(); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void EndInitialization() { + this.VstoSmartTags.EndInit(); + this.CustomTaskPanes.EndInit(); + this.EndInit(); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void InitializeControls() { + this.CustomTaskPanes = Globals.Factory.CreateCustomTaskPaneCollection(null, null, "CustomTaskPanes", "CustomTaskPanes", this); + this.VstoSmartTags = Globals.Factory.CreateSmartTagCollection(null, null, "VstoSmartTags", "VstoSmartTags", this); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + private void InitializeComponents() { + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + private bool NeedsFill(string MemberName) { + return this.DataHost.NeedsFill(this, MemberName); + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)] + protected override void OnShutdown() { + this.VstoSmartTags.Dispose(); + this.CustomTaskPanes.Dispose(); + base.OnShutdown(); + } + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + internal sealed partial class Globals { + + /// + private Globals() { + } + + private static ThisAddIn _ThisAddIn; + + private static global::Microsoft.Office.Tools.Word.ApplicationFactory _factory; + + private static ThisRibbonCollection _ThisRibbonCollection; + + internal static ThisAddIn ThisAddIn { + get { + return _ThisAddIn; + } + set { + if ((_ThisAddIn == null)) { + _ThisAddIn = value; + } + else { + throw new System.NotSupportedException(); + } + } + } + + internal static global::Microsoft.Office.Tools.Word.ApplicationFactory Factory { + get { + return _factory; + } + set { + if ((_factory == null)) { + _factory = value; + } + else { + throw new System.NotSupportedException(); + } + } + } + + internal static ThisRibbonCollection Ribbons { + get { + if ((_ThisRibbonCollection == null)) { + _ThisRibbonCollection = new ThisRibbonCollection(_factory.GetRibbonFactory()); + } + return _ThisRibbonCollection; + } + } + } + + /// + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Tools.Office.ProgrammingModel.dll", "17.0.0.0")] + internal sealed partial class ThisRibbonCollection : Microsoft.Office.Tools.Ribbon.RibbonCollectionBase { + + /// + internal ThisRibbonCollection(global::Microsoft.Office.Tools.Ribbon.RibbonFactory factory) : + base(factory) { + } + } +} diff --git a/TestWordAddIn1/ThisAddIn.Designer.xml b/TestWordAddIn1/ThisAddIn.Designer.xml new file mode 100644 index 0000000..7916359 --- /dev/null +++ b/TestWordAddIn1/ThisAddIn.Designer.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/TestWordAddIn1/ThisAddIn.cs b/TestWordAddIn1/ThisAddIn.cs new file mode 100644 index 0000000..fb8f27d --- /dev/null +++ b/TestWordAddIn1/ThisAddIn.cs @@ -0,0 +1,215 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Xml.Linq; +using Microsoft.Office.Interop.Word; +using System.Runtime.InteropServices; +using CustomTaskPane = Microsoft.Office.Tools.CustomTaskPane; +using System.Windows.Forms; + +namespace TestWordAddIn1 +{ + public partial class ThisAddIn + { + + public OfficeType officeType = OfficeType.Word; + public string applicationStartupPath; + public bool proofreadPanelOpen; + private ProofreadPanel proofreadPanel; + private Dictionary myTaskPanes; + private CustomTaskPane myCustomTaskPane; + + private void ThisAddIn_Startup(object sender, System.EventArgs e) + { + this.applicationStartupPath = System.Windows.Forms.Application.ProductName; + + if (applicationStartupPath.Contains("WPS")) + { + this.officeType = OfficeType.WPS; + return; + } + var eventInfo = new ComAwareEventInfo(typeof(ApplicationEvents4_Event), "DocumentOpen"); + var handler = new ApplicationEvents4_DocumentOpenEventHandler(Application_DocumentOpen); + + // 监听文档相关操作 + //eventInfo.AddEventHandler(this, handler); + //new ComAwareEventInfo(typeof(ApplicationEvents4_Event), "NewDocument").AddEventHandler(Application, new ApplicationEvents4_NewDocumentEventHandler(Application_NewDocument)); + //new ComAwareEventInfo(typeof(ApplicationEvents4_Event), "WindowActivate").AddEventHandler(Application, new ApplicationEvents4_WindowActivateEventHandler(Application_WindowActivate)); + //new ComAwareEventInfo(typeof(ApplicationEvents4_Event), "WindowDeactivate").AddEventHandler(Application, new ApplicationEvents4_WindowDeactivateEventHandler(Application_WindowDeactivate)); + + } + + /// + /// 隐藏所有的面板 + /// + void HideAllPane() + { + foreach (CustomTaskPane customTaskPane in CustomTaskPanes) + { + customTaskPane.Visible = false; + } + } + + private void Application_NewDocument(Document doc) + { + Console.WriteLine("Application_NewDocument"); + InitProofreadPanel(); + HideAllPane(); + } + + private void Application_DocumentOpen(Document doc) + { + Console.WriteLine("Application_DocumentOpen"); + InitProofreadPanel(); + HideAllPane(); + } + + private void Application_DocumentChange() + { + Console.WriteLine("Application_DocumentChange"); + ShowTaskPaneForActiveDocument(); + } + + + private void ShowTaskPaneForActiveDocument() + { + // 获取当前文档 + Document activeDocument = Application.ActiveDocument; + // 如果现有任务不包含文档则直接返回 + if (!myTaskPanes.ContainsKey(activeDocument)) + { + return; + } + // 显示当前文档panel隐藏其他文档panel + foreach (var item in myTaskPanes) + { + if (item.Key == activeDocument) + { + item.Value.Visible = true; + } + else + { + item.Value.Visible = false; + } + } + } + + public void Application_WindowActivate_WPS(Document document, Window window) + { + Console.WriteLine("Application_WindowActivate_WPS"); + if (myCustomTaskPane == null) + { + InitProofreadPanel(); + } + } + + public void Application_WindowActivate(Document document, Window window) + { + Console.WriteLine("Application_WindowActivate"); + //bool flag = true; + //if (myTaskPanes != null) + //{ + // foreach (KeyValuePair customTaskPane in myTaskPanes) + // { + // if (customTaskPane.Key == Application.ActiveDocument) + // { + // flag = false; + // myCustomTaskPane = customTaskPane.Value; + // proofreadPanel = userControls[Application.ActiveDocument]; + // myCustomTaskPane.Visible = customTaskPanesVisible[Application.ActiveDocument]; + // break; + // } + // } + // if (flag) + // { + // NewCustomTaskPane(); + // } + //} + //else + //{ + // NewCustomTaskPane(); + //} + //Globals.Ribbons.Ribbon.button_viewOn.Visible = !myCustomTaskPane.Visible; + //Globals.Ribbons.Ribbon.button_viewOff.Visible = myCustomTaskPane.Visible; + } + + public void Application_WindowDeactivate(Document document, Window window) + { + Console.WriteLine("Application_WindowDeactivate"); + //if (customTaskPanesVisible.ContainsKey(document)) + //{ + // customTaskPanesVisible[document] = myCustomTaskPane.Visible; + //} + //else + //{ + // customTaskPanesVisible.Add(document, myCustomTaskPane.Visible); + //} + } + + /// + /// 面板最小宽度 + /// + private static readonly int MIN_WIDTH = 380; + + void InitProofreadPanel() + { + if(this.myCustomTaskPane == null) + { + // 创建 + proofreadPanel = new ProofreadPanel(); + // 添加到panes + this.myCustomTaskPane = CustomTaskPanes.Add(proofreadPanel, AppConfig.PanelName); + // 先隐藏 + this.myCustomTaskPane.Visible = false; + myCustomTaskPane.Width = MIN_WIDTH; + this.myCustomTaskPane.VisibleChanged += OnProofreadPanel_VisibleChange; + // 添加到集合 + //this.myTaskPanes.Add(Application.ActiveDocument, this.myCustomTaskPane); + } + + } + + // 当面板的显示变化时 + private void OnProofreadPanel_VisibleChange(object sender, EventArgs e) + { + if(this.myCustomTaskPane != null && myCustomTaskPane.Width < MIN_WIDTH) + { + this.myCustomTaskPane.Width = MIN_WIDTH; + } + } + + private void ThisAddIn_Shutdown(object sender, System.EventArgs e) + { + } + + public void SetPanelVisible(bool open) + { + if (this.proofreadPanelOpen == open) return; + + this.InitProofreadPanel(); + this.proofreadPanelOpen = open; + this.myCustomTaskPane.Visible = this.proofreadPanelOpen; + } + public bool TogglePanelVisible() + { + this.proofreadPanelOpen = !this.proofreadPanelOpen; + this.myCustomTaskPane.Visible = this.proofreadPanelOpen; + return this.proofreadPanelOpen; + } + + #region VSTO 生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InternalStartup() + { + this.Startup += new System.EventHandler(ThisAddIn_Startup); + this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown); + } + + #endregion + } +} diff --git a/TestWordAddIn1/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs b/TestWordAddIn1/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs new file mode 100644 index 0000000..edc4647 --- /dev/null +++ b/TestWordAddIn1/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs @@ -0,0 +1,4 @@ +// +using System; +using System.Reflection; +[assembly: global::System.Runtime.Versioning.TargetFrameworkAttribute(".NETFramework,Version=v4.6.2", FrameworkDisplayName = ".NET Framework 4.6.2")] diff --git a/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferences.cache new file mode 100644 index 0000000..1cb6feb Binary files /dev/null and b/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..600850c Binary files /dev/null and b/TestWordAddIn1/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/TestWordAddIn1/obj/Debug/TempPE/Properties.Resources.Designer.cs.dll b/TestWordAddIn1/obj/Debug/TempPE/Properties.Resources.Designer.cs.dll new file mode 100644 index 0000000..cb6b3d0 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TempPE/Properties.Resources.Designer.cs.dll differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.Form1.resources b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Form1.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Form1.resources differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadItem.resources b/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadItem.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadItem.resources differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadPanel.resources b/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadPanel.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.ProofreadPanel.resources differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.Properties.Resources.resources b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Properties.Resources.resources new file mode 100644 index 0000000..7dbba6e Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Properties.Resources.resources differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.Ribbon1.resources b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Ribbon1.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.Ribbon1.resources differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.AssemblyReference.cache b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.AssemblyReference.cache new file mode 100644 index 0000000..689d776 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.AssemblyReference.cache differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.CopyComplete b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.CopyComplete new file mode 100644 index 0000000..e69de29 diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.CoreCompileInputs.cache b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.CoreCompileInputs.cache new file mode 100644 index 0000000..8d138eb --- /dev/null +++ b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.CoreCompileInputs.cache @@ -0,0 +1 @@ +46fabd4c02277f5287e9e4cc8a8baf270df54dfc diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.FileListAbsolute.txt b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..2948895 --- /dev/null +++ b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.FileListAbsolute.txt @@ -0,0 +1,31 @@ +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\TestWordAddIn1.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\TestWordAddIn1.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\TestWordAddIn1.dll.manifest +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\TestWordAddIn1.vsto +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Office.Tools.Common.v4.0.Utilities.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.csproj.AssemblyReference.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.Properties.Resources.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.Ribbon1.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.csproj.GenerateResource.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.csproj.CoreCompileInputs.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.csproj.CopyComplete +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.Form1.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Newtonsoft.Json.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Newtonsoft.Json.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.ProofreadPanel.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\runtimes\win-x86\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\runtimes\win-x64\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\runtimes\win-arm64\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.Core.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.WinForms.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.Wpf.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.Core.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.WinForms.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\Microsoft.Web.WebView2.Wpf.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\web\index.html +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Debug\TestWordAddIn1.ProofreadItem.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\UtilLib.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\UtilLib.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Debug\UtilLib.dll.config diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.GenerateResource.cache b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.GenerateResource.cache new file mode 100644 index 0000000..c339374 Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.csproj.GenerateResource.cache differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.dll b/TestWordAddIn1/obj/Debug/TestWordAddIn1.dll new file mode 100644 index 0000000..6b0c91d Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.dll differ diff --git a/TestWordAddIn1/obj/Debug/TestWordAddIn1.pdb b/TestWordAddIn1/obj/Debug/TestWordAddIn1.pdb new file mode 100644 index 0000000..fe118cb Binary files /dev/null and b/TestWordAddIn1/obj/Debug/TestWordAddIn1.pdb differ diff --git a/TestWordAddIn1/obj/Release/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs b/TestWordAddIn1/obj/Release/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs new file mode 100644 index 0000000..edc4647 --- /dev/null +++ b/TestWordAddIn1/obj/Release/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs @@ -0,0 +1,4 @@ +// +using System; +using System.Reflection; +[assembly: global::System.Runtime.Versioning.TargetFrameworkAttribute(".NETFramework,Version=v4.6.2", FrameworkDisplayName = ".NET Framework 4.6.2")] diff --git a/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferences.cache b/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferences.cache new file mode 100644 index 0000000..3323826 Binary files /dev/null and b/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferences.cache differ diff --git a/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache b/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..03c577c Binary files /dev/null and b/TestWordAddIn1/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/TestWordAddIn1/obj/Release/TempPE/Properties.Resources.Designer.cs.dll b/TestWordAddIn1/obj/Release/TempPE/Properties.Resources.Designer.cs.dll new file mode 100644 index 0000000..35745c4 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TempPE/Properties.Resources.Designer.cs.dll differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.Form1.resources b/TestWordAddIn1/obj/Release/TestWordAddIn1.Form1.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.Form1.resources differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.Properties.Resources.resources b/TestWordAddIn1/obj/Release/TestWordAddIn1.Properties.Resources.resources new file mode 100644 index 0000000..fbfbc9d Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.Properties.Resources.resources differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.Ribbon1.resources b/TestWordAddIn1/obj/Release/TestWordAddIn1.Ribbon1.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.Ribbon1.resources differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.AssemblyReference.cache b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.AssemblyReference.cache new file mode 100644 index 0000000..a59cabf Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.AssemblyReference.cache differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.CopyComplete b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.CopyComplete new file mode 100644 index 0000000..e69de29 diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.CoreCompileInputs.cache b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.CoreCompileInputs.cache new file mode 100644 index 0000000..e28e1c3 --- /dev/null +++ b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.CoreCompileInputs.cache @@ -0,0 +1 @@ +487d1bb5458f1f46fd33ce520a82e0b8d2655794 diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.FileListAbsolute.txt b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..c637ab1 --- /dev/null +++ b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.FileListAbsolute.txt @@ -0,0 +1,14 @@ +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Release\TestWordAddIn1.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Release\TestWordAddIn1.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Release\TestWordAddIn1.dll.manifest +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Release\TestWordAddIn1.vsto +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\bin\Release\Microsoft.Office.Tools.Common.v4.0.Utilities.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.csproj.AssemblyReference.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.Form1.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.Properties.Resources.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.Ribbon1.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.csproj.GenerateResource.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.csproj.CoreCompileInputs.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.csproj.CopyComplete +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\TestWordAddIn1\obj\Release\TestWordAddIn1.pdb diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.GenerateResource.cache b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.GenerateResource.cache new file mode 100644 index 0000000..9464dc9 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.csproj.GenerateResource.cache differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.dll b/TestWordAddIn1/obj/Release/TestWordAddIn1.dll new file mode 100644 index 0000000..0bd8013 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.dll differ diff --git a/TestWordAddIn1/obj/Release/TestWordAddIn1.pdb b/TestWordAddIn1/obj/Release/TestWordAddIn1.pdb new file mode 100644 index 0000000..d3b79c2 Binary files /dev/null and b/TestWordAddIn1/obj/Release/TestWordAddIn1.pdb differ diff --git a/TestWordAddIn1/packages.config b/TestWordAddIn1/packages.config new file mode 100644 index 0000000..ab76337 --- /dev/null +++ b/TestWordAddIn1/packages.config @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/TestWordAddIn1/web/index.html b/TestWordAddIn1/web/index.html new file mode 100644 index 0000000..e9c8fdd --- /dev/null +++ b/TestWordAddIn1/web/index.html @@ -0,0 +1,24 @@ + + + + test + + + + + + + + \ No newline at end of file diff --git a/UtilLib/API.cs b/UtilLib/API.cs new file mode 100644 index 0000000..d6edadc --- /dev/null +++ b/UtilLib/API.cs @@ -0,0 +1,20 @@ +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class API + { + private static readonly string API_URL = "http://test.wx.wm-app.xyz/proofread.json"; + public static ProofreadResult GetProofreadResult() + { + var content = Http.Get(API_URL); + var result = JsonConvert.DeserializeObject>(content); + return result.Data; + } + } +} diff --git a/UtilLib/AcceptEnum.cs b/UtilLib/AcceptEnum.cs new file mode 100644 index 0000000..10f57fd --- /dev/null +++ b/UtilLib/AcceptEnum.cs @@ -0,0 +1,28 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public enum AcceptEnum + { + /// + /// 默认(未处理) + /// + Default = 0, + /// + /// 复核 + /// + Review = 1, + /// + /// 采纳 + /// + Accept = 2, + /// + /// 忽略 + /// + Ignore = 3 + } +} diff --git a/UtilLib/App.config b/UtilLib/App.config new file mode 100644 index 0000000..b50c74f --- /dev/null +++ b/UtilLib/App.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/UtilLib/Colors.cs b/UtilLib/Colors.cs new file mode 100644 index 0000000..5410999 --- /dev/null +++ b/UtilLib/Colors.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class Colors + { + public static Color FromHex(string hex) + { + hex = hex.TrimStart('#'); + int hexValue = Convert.ToInt32(hex, 16); + byte red = (byte)((hexValue >> 16) & 0xFF); + byte green = (byte)((hexValue >> 8) & 0xFF); + byte blue = (byte)(hexValue & 0xFF); + return FromRGB(red, green, blue); + } + public static Color FromRGB(byte red, byte green, byte blue) + { + return Color.FromArgb(red, green, blue); + } + } +} diff --git a/UtilLib/Correct.cs b/UtilLib/Correct.cs new file mode 100644 index 0000000..8e3dbc9 --- /dev/null +++ b/UtilLib/Correct.cs @@ -0,0 +1,19 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class Correct + { + public string Key { get; set; } + public int Offset { get; set; } + public string New_text { get; set; } + public string Insert { get; set; } + public int Insert_len { get; set; } + + public List Diffs { get; set; } + } +} diff --git a/UtilLib/DiffItem.cs b/UtilLib/DiffItem.cs new file mode 100644 index 0000000..3a7a52e --- /dev/null +++ b/UtilLib/DiffItem.cs @@ -0,0 +1,21 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class DiffItem + { + public string Tag { get; set; } + public string Origin { get; set; } + public string Text { get; set; } + public int Start { get; set; } + public int End { get; set; } + public int Id { get; set; } + public int Idx { get; set; } + public AcceptEnum IsAccept { get; set; } + public ProofreadType Type { get; set; } + } +} diff --git a/UtilLib/Http.cs b/UtilLib/Http.cs new file mode 100644 index 0000000..34c1ed7 --- /dev/null +++ b/UtilLib/Http.cs @@ -0,0 +1,19 @@ +using System; +using System.IO; +using System.Net; + +namespace UtilLib +{ + internal class Http + { + public static String Get(string url) + { + HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url); + var res = req.GetResponse(); + using (var reader = new StreamReader(res.GetResponseStream())) + { + return reader.ReadToEnd(); + } + } + } +} diff --git a/UtilLib/ProofreadResult.cs b/UtilLib/ProofreadResult.cs new file mode 100644 index 0000000..dfb5693 --- /dev/null +++ b/UtilLib/ProofreadResult.cs @@ -0,0 +1,30 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class ProofreadResult + { + public object AbnormalCount { get; set; } + public List CorrectedSet { get; set; } + public object History { get; set; } + + /* + "id": 1326, + "isBlackWord": true, + "isOrigin": 2, + "isWhiteWord": true, + "name": "失业在家的日子-最新", + "status": 3 + */ + public int Id { get; set; } + public bool IsBlackWord { get; set; } + public int IsOrigin { get; set; } + public bool IsWhiteWord { get; set; } + public int Status { get; set; } + public string Name { get; set; } + } +} diff --git a/UtilLib/ProofreadType.cs b/UtilLib/ProofreadType.cs new file mode 100644 index 0000000..1efda8a --- /dev/null +++ b/UtilLib/ProofreadType.cs @@ -0,0 +1,72 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public enum ProofreadType + { + /// + /// 未知 + /// + unknown, + /// + /// 黑名单 + /// + blackWord, + /** + * 字错 + */ + characterError, + /** + * 词错 + */ + wordError, + /** + * 数字错 + */ + numberError, + /** + * 计量单位错 + */ + unitsError, + /** + * 标点错 + */ + punctuationError, + /** + * 语法错 + */ + grammarError, + /** + * 知识性差错 + */ + knowledgeableError, + /** + * 倾向性差错 + */ + tendentiousError, + /** + * 不⼀致 + */ + inconsistentError, + /** + * 格式错 + */ + formatError, + /// + /// 敏感词 + /// + sensitive, + /// + /// 黑名单-替换 + /// + blackWordReplace = 14, + /// + /// 黑名单-拦截 + /// + blackWordBlock = 15, + } +} diff --git a/UtilLib/Response.cs b/UtilLib/Response.cs new file mode 100644 index 0000000..f958a7e --- /dev/null +++ b/UtilLib/Response.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class Response + { + public int Code { get; set; } + public string Msg { get; set; } + public T Data { get; set; } + } + +} \ No newline at end of file diff --git a/UtilLib/TypeConfig.cs b/UtilLib/TypeConfig.cs new file mode 100644 index 0000000..b670cb1 --- /dev/null +++ b/UtilLib/TypeConfig.cs @@ -0,0 +1,83 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class TypeConfig + { + /* + {id:[ProofreadTypeEnum.blackWord, ProofreadTypeEnum.blackWordBlock, ProofreadTypeEnum.blackWordReplace], type: 'black',acceptAll:[ProofreadTypeEnum.blackWordReplace],ignoreAll:[ProofreadTypeEnum.blackWordBlock, ProofreadTypeEnum.blackWordReplace], count: 0, text: '黑名单', color: '#2A2A2A',key:'blackWord'}, + {id:ProofreadTypeEnum.characterError,type: 'char', count: 0, text: '提示', color: '#FD6643',key:'characterError'}, + { id: ProofreadTypeEnum.wordError,type: 'word', count: 0, text: '词错', color: '#29CEC0',key: 'wordError'}, + { id: ProofreadTypeEnum.numberError,type: 'number', count: 0, text: '数字错', color: '#c9c9c9',key: 'numberError'}, + { id: ProofreadTypeEnum.punctuationError,type: 'symbol', count: 0, text: '标点错', color: '#558CB7',key: 'punctuationError'}, + { id: ProofreadTypeEnum.unitsError,type: 'unit', count: 0, text: '计量单位错', color: '#77F1AE',key: 'unitsError'}, + { id: ProofreadTypeEnum.grammarError,type: 'syntax', count: 0, text: '语法错误', color: '#CDAFE5',key: 'grammarError'}, + { id: ProofreadTypeEnum.knowledgeableError,type: 'info', count: 0, text: '知识性错误', color: '#B2CCE6',key: 'knowledgeableError'}, + { id: ProofreadTypeEnum.tendentiousError,type: 'tendency', count: 0, text: '倾向性错误', color: '#E2AACA',key: 'tendentiousError'}, + { id: ProofreadTypeEnum.inconsistentError,type: 'inconsistent', count: 0, text: '不一致错误', color: '#E0AAAC',key: 'inconsistentError'}, + { id: ProofreadTypeEnum.formatError,type: 'format', count: 0, text: '格式错误', color: '#E9D0A7',key: 'formatError'}, + { id: ProofreadTypeEnum.sensitive,type: 'sensitive', count: 0, text: '敏感词', color: '#e971ba',key: 'sensitive'}, + */ + public ProofreadType Type { get; set; } + public string Text { get; set; } + public string Name { get; set; } + public string Color { get; set; } + + public static TypeConfig BlackWord = new TypeConfig(ProofreadType.blackWord, "黑名单", "black", "#2A2A2A"); + public static TypeConfig BlackWordBlock = new TypeConfig(ProofreadType.blackWordBlock, "黑名单", "black", "#2A2A2A"); + public static TypeConfig BlackWordReplace = new TypeConfig(ProofreadType.blackWordReplace, "黑名单", "black", "#2A2A2A"); + public static TypeConfig CharacterError = new TypeConfig(ProofreadType.characterError, "提示", "characterError", "#FD6643"); + public static TypeConfig WordError = new TypeConfig(ProofreadType.wordError, "词错", "wordError", "#29CEC0"); + public static TypeConfig NumberError = new TypeConfig(ProofreadType.numberError, "数字错", "numberError", "#c9c9c9"); + public static TypeConfig PunctuationError = new TypeConfig(ProofreadType.punctuationError, "标点错", "punctuationError", "#558CB7"); + public static TypeConfig UnitsError = new TypeConfig(ProofreadType.unitsError, "计量单位错", "unitsError", "#77F1AE"); + public static TypeConfig GrammarError = new TypeConfig(ProofreadType.grammarError, "语法错误", "grammarError", "#CDAFE5"); + public static TypeConfig KnowledgeableError = new TypeConfig(ProofreadType.knowledgeableError, "知识性错误", "knowledgeableError", "#B2CCE6"); + public static TypeConfig TendentiousError = new TypeConfig(ProofreadType.tendentiousError, "倾向性错误", "tendentiousError", "#E2AACA"); + public static TypeConfig InconsistentError = new TypeConfig(ProofreadType.inconsistentError, "不一致错误", "inconsistentError", "#E0AAAC"); + public static TypeConfig FormatError = new TypeConfig(ProofreadType.formatError, "格式错误", "formatError", "#E9D0A7"); + public static TypeConfig Sensitive = new TypeConfig(ProofreadType.sensitive, "敏感词", "sensitive", "#e971ba"); + + private static Dictionary AllTypeConfig = null; + + public TypeConfig(ProofreadType type, string text, string name, string color) + { + this.Type = type; + this.Text = text; + this.Name = name; + this.Color = color; + } + public TypeConfig() + { + + } + static void Init() + { + if (AllTypeConfig != null) return; + AllTypeConfig = new Dictionary(); + AllTypeConfig.Add(ProofreadType.punctuationError, PunctuationError); + AllTypeConfig.Add(ProofreadType.numberError, NumberError); + AllTypeConfig.Add(ProofreadType.tendentiousError, TendentiousError); + AllTypeConfig.Add(ProofreadType.wordError, WordError); + AllTypeConfig.Add(ProofreadType.blackWord, BlackWord); + AllTypeConfig.Add(ProofreadType.blackWordBlock, BlackWordBlock); + AllTypeConfig.Add(ProofreadType.blackWordReplace, BlackWordReplace); + AllTypeConfig.Add(ProofreadType.characterError, CharacterError); + AllTypeConfig.Add(ProofreadType.formatError, FormatError); + AllTypeConfig.Add(ProofreadType.grammarError, GrammarError); + AllTypeConfig.Add(ProofreadType.inconsistentError, InconsistentError); + AllTypeConfig.Add(ProofreadType.knowledgeableError, KnowledgeableError); + AllTypeConfig.Add(ProofreadType.sensitive, Sensitive); + } + + public static TypeConfig Get(ProofreadType type) + { + Init(); + return AllTypeConfig[type]; + } + } +} diff --git a/UtilLib/UtilLib.csproj b/UtilLib/UtilLib.csproj new file mode 100644 index 0000000..346b633 --- /dev/null +++ b/UtilLib/UtilLib.csproj @@ -0,0 +1,65 @@ + + + + + Debug + AnyCPU + {724D79C5-93B5-4BD7-9964-A05CCEFD3BFA} + Library + UtilLib + UtilLib + v4.6.2 + 512 + true + true + + + AnyCPU + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + ..\packages\Newtonsoft.Json.13.0.3\lib\net45\Newtonsoft.Json.dll + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/UtilLib/WebActionMessage.cs b/UtilLib/WebActionMessage.cs new file mode 100644 index 0000000..2c549a3 --- /dev/null +++ b/UtilLib/WebActionMessage.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace UtilLib +{ + public class WebActionMessage + { + public WebActionMessage() + { } + public WebActionMessage(string action, object data) + { + Action = action; + Data = data; + } + + public string Action { get; set; } + public object Data { get; set; } + } +} diff --git a/UtilLib/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs b/UtilLib/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs new file mode 100644 index 0000000..edc4647 --- /dev/null +++ b/UtilLib/obj/Debug/.NETFramework,Version=v4.6.2.AssemblyAttributes.cs @@ -0,0 +1,4 @@ +// +using System; +using System.Reflection; +[assembly: global::System.Runtime.Versioning.TargetFrameworkAttribute(".NETFramework,Version=v4.6.2", FrameworkDisplayName = ".NET Framework 4.6.2")] diff --git a/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferences.cache new file mode 100644 index 0000000..7e998a7 Binary files /dev/null and b/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..7e556fd Binary files /dev/null and b/UtilLib/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/UtilLib/obj/Debug/UtilLib.csproj.AssemblyReference.cache b/UtilLib/obj/Debug/UtilLib.csproj.AssemblyReference.cache new file mode 100644 index 0000000..6a732cc Binary files /dev/null and b/UtilLib/obj/Debug/UtilLib.csproj.AssemblyReference.cache differ diff --git a/UtilLib/obj/Debug/UtilLib.csproj.CopyComplete b/UtilLib/obj/Debug/UtilLib.csproj.CopyComplete new file mode 100644 index 0000000..e69de29 diff --git a/UtilLib/obj/Debug/UtilLib.csproj.CoreCompileInputs.cache b/UtilLib/obj/Debug/UtilLib.csproj.CoreCompileInputs.cache new file mode 100644 index 0000000..7d5b06b --- /dev/null +++ b/UtilLib/obj/Debug/UtilLib.csproj.CoreCompileInputs.cache @@ -0,0 +1 @@ +fb8f34c352a3d8044db8982ce7a7eb73c62ae6db diff --git a/UtilLib/obj/Debug/UtilLib.csproj.FileListAbsolute.txt b/UtilLib/obj/Debug/UtilLib.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..cf72296 --- /dev/null +++ b/UtilLib/obj/Debug/UtilLib.csproj.FileListAbsolute.txt @@ -0,0 +1,10 @@ +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\obj\Debug\UtilLib.csproj.AssemblyReference.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\obj\Debug\UtilLib.csproj.CoreCompileInputs.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\bin\Debug\UtilLib.dll.config +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\bin\Debug\UtilLib.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\bin\Debug\UtilLib.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\bin\Debug\Newtonsoft.Json.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\bin\Debug\Newtonsoft.Json.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\obj\Debug\UtilLib.csproj.CopyComplete +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\obj\Debug\UtilLib.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\UtilLib\obj\Debug\UtilLib.pdb diff --git a/UtilLib/obj/Debug/UtilLib.dll b/UtilLib/obj/Debug/UtilLib.dll new file mode 100644 index 0000000..587590b Binary files /dev/null and b/UtilLib/obj/Debug/UtilLib.dll differ diff --git a/UtilLib/obj/Debug/UtilLib.pdb b/UtilLib/obj/Debug/UtilLib.pdb new file mode 100644 index 0000000..31795ea Binary files /dev/null and b/UtilLib/obj/Debug/UtilLib.pdb differ diff --git a/UtilLib/packages.config b/UtilLib/packages.config new file mode 100644 index 0000000..6f243a9 --- /dev/null +++ b/UtilLib/packages.config @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/Webview2WinFormsApp/AutoAdaptWindowsSize.cs b/Webview2WinFormsApp/AutoAdaptWindowsSize.cs new file mode 100644 index 0000000..279bbbc --- /dev/null +++ b/Webview2WinFormsApp/AutoAdaptWindowsSize.cs @@ -0,0 +1,119 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +//using System.Linq; +using System.Text; +using System.Windows.Forms; +using System.Drawing.Drawing2D; + +namespace Webview2WinFormsApp +{ + class AutoAdaptWindowsSize //窗口缩放对象 + { + double formOriginalWidth;//窗体高度原始宽度 + double formOriginalHeight;//窗体原始 + double scaleX;//水平缩放比例 + double scaleY;//垂直缩放比例 + readonly Dictionary ControlsInfo = new Dictionary();//控件中心Left,Top,控件Width,控件Height,控件字体Size + + private Form _form; + Panel Win_Panel1 = new Panel(); + public AutoAdaptWindowsSize(Form form) + { + _form = form; + + //代码生成一个容器panel1，添加至窗体 + _form.Controls.Add(Win_Panel1); + Win_Panel1.BorderStyle = BorderStyle.None; //容器border样式 + Win_Panel1.Dock = DockStyle.Fill; //设置填充，下面添加控件至容器完成后，容器会填充窗口 + Win_Panel1.BackColor = Color.Transparent; // 这里默认的背景颜色是form的背景颜色，如果form页面时图片，需要将这里的颜色设置成透明，否则会被覆盖。 + //将窗体所有控件添加至panel1 + while (_form.Controls[0].Name.Trim() != "") + { + foreach (Control item in _form.Controls) + { + + if (item.Name.Trim() != "" && item.Name.Trim() != Win_Panel1.Name.Trim()) + { + Win_Panel1.Controls.Add(item); + } + } + } + + //保存窗体和控件初始大小 + InitControlsInfo(Win_Panel1); + } + + public void InitControlsInfo(Control ctrlContainer) + { + if (ctrlContainer.Parent == _form)//获取窗体的高度和宽度 + { + formOriginalWidth = Convert.ToDouble(ctrlContainer.Width); + formOriginalHeight = Convert.ToDouble(ctrlContainer.Height); + } + foreach (Control item in ctrlContainer.Controls) + { + if (item.Name.Trim() != "") + { + //添加信息：键值：控件名，内容：据左边距离，距顶部距离，控件宽度，控件高度，控件字体。 + ControlsInfo.Add(item.Name, (item.Left + item.Width / 2) + "," + (item.Top + item.Height / 2) + "," + item.Width + "," + item.Height + "," + item.Font.Size); + } + if ((item as UserControl) == null && item.Controls.Count > 0) + { + InitControlsInfo(item); + } + } + + } + public void FormSizeChanged() + { + try + { + if (ControlsInfo.Count > 0)//如果字典中有数据，即窗体改变 + { + ControlsZoomScale(Win_Panel1);//表示pannel控件 + ControlsChange(Win_Panel1); + } + } + catch { } + } + private void ControlsZoomScale(Control ctrlContainer) + { + scaleX = (Convert.ToDouble(ctrlContainer.Width) / formOriginalWidth); + scaleY = (Convert.ToDouble(ctrlContainer.Height) / formOriginalHeight); + } + + // 改变控件大小 + + private void ControlsChange(Control ctrlContainer) + { + double[] pos = new double[5];//pos数组保存当前控件中心Left,Top,控件Width,控件Height,控件字体Size + foreach (Control item in ctrlContainer.Controls)//遍历控件 + { + if (item.Name.Trim() != "")//如果控件名不是空，则执行 + { + if ((item as UserControl) == null && item.Controls.Count > 0)//如果不是自定义控件 + { + ControlsChange(item);//循环执行 + } + string[] strs = ControlsInfo[item.Name].Split(',');//从字典中查出的数据，以‘，’分割成字符串组 + + for (int i = 0; i < 5; i++) + { + pos[i] = Convert.ToDouble(strs[i]);//添加到临时数组 + } + double itemWidth = pos[2] * scaleX; //计算控件宽度，double类型 + double itemHeight = pos[3] * scaleY; //计算控件高度 + item.Left = Convert.ToInt32(pos[0] * scaleX - itemWidth / 2);//计算控件距离左边距离 + item.Top = Convert.ToInt32(pos[1] * scaleY - itemHeight / 2);//计算控件距离顶部距离 + item.Width = Convert.ToInt32(itemWidth);//控件宽度，int类型 + item.Height = Convert.ToInt32(itemHeight);//控件高度 + if (float.Parse((pos[4] * Math.Min(scaleX, scaleY)).ToString()) != 0) //缩放字体大小不能为0 + { item.Font = new Font(item.Font.Name, float.Parse((pos[4] * Math.Min(scaleX, scaleY)).ToString())); } //字体 + } + } + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/Bridge.cs b/Webview2WinFormsApp/Bridge.cs new file mode 100644 index 0000000..7602639 --- /dev/null +++ b/Webview2WinFormsApp/Bridge.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Webview2WinFormsApp +{ + public class Bridge + { + public void Test() + { + System.Windows.Forms.MessageBox.Show("Webview2WinFormsApp.Bridge.Test()!"); + } + } +} diff --git a/Webview2WinFormsApp/Form1.Designer.cs b/Webview2WinFormsApp/Form1.Designer.cs new file mode 100644 index 0000000..f730e5b --- /dev/null +++ b/Webview2WinFormsApp/Form1.Designer.cs @@ -0,0 +1,106 @@ +namespace Webview2WinFormsApp +{ + partial class Form1 + { + /// + /// Required designer variable. + /// + private System.ComponentModel.IContainer components = null; + + /// + /// Clean up any resources being used. + /// + /// true if managed resources should be disposed; otherwise, false. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows Form Designer generated code + + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + webView21 = new Microsoft.Web.WebView2.WinForms.WebView2(); + menuStrip1 = new MenuStrip(); + 文件ToolStripMenuItem = new ToolStripMenuItem(); + 编辑ToolStripMenuItem = new ToolStripMenuItem(); + 视图ToolStripMenuItem = new ToolStripMenuItem(); + ((System.ComponentModel.ISupportInitialize)webView21).BeginInit(); + menuStrip1.SuspendLayout(); + SuspendLayout(); + // + // webView21 + // + webView21.AllowExternalDrop = true; + webView21.CreationProperties = null; + webView21.DefaultBackgroundColor = Color.White; + webView21.Dock = DockStyle.Fill; + webView21.Location = new Point(0, 25); + webView21.Name = "webView21"; + webView21.Size = new Size(998, 600); + webView21.TabIndex = 0; + webView21.ZoomFactor = 1D; + webView21.CoreWebView2InitializationCompleted += webView21_CoreWebView2InitializationCompleted; + // + // menuStrip1 + // + menuStrip1.Items.AddRange(new ToolStripItem[] { 文件ToolStripMenuItem, 编辑ToolStripMenuItem, 视图ToolStripMenuItem }); + menuStrip1.Location = new Point(0, 0); + menuStrip1.Name = "menuStrip1"; + menuStrip1.Size = new Size(998, 25); + menuStrip1.TabIndex = 1; + menuStrip1.Text = "menuStrip1"; + // + // 文件ToolStripMenuItem + // + 文件ToolStripMenuItem.Name = "文件ToolStripMenuItem"; + 文件ToolStripMenuItem.Size = new Size(44, 21); + 文件ToolStripMenuItem.Text = "文件"; + // + // 编辑ToolStripMenuItem + // + 编辑ToolStripMenuItem.Name = "编辑ToolStripMenuItem"; + 编辑ToolStripMenuItem.Size = new Size(44, 21); + 编辑ToolStripMenuItem.Text = "编辑"; + // + // 视图ToolStripMenuItem + // + 视图ToolStripMenuItem.Name = "视图ToolStripMenuItem"; + 视图ToolStripMenuItem.Size = new Size(44, 21); + 视图ToolStripMenuItem.Text = "视图"; + // + // Form1 + // + AutoScaleDimensions = new SizeF(7F, 17F); + AutoScaleMode = AutoScaleMode.Font; + ClientSize = new Size(998, 625); + Controls.Add(webView21); + Controls.Add(menuStrip1); + MainMenuStrip = menuStrip1; + Name = "Form1"; + Text = "Form1"; + Load += Form1_Load; + ((System.ComponentModel.ISupportInitialize)webView21).EndInit(); + menuStrip1.ResumeLayout(false); + menuStrip1.PerformLayout(); + ResumeLayout(false); + PerformLayout(); + } + + #endregion + + private Microsoft.Web.WebView2.WinForms.WebView2 webView21; + private MenuStrip menuStrip1; + private ToolStripMenuItem 文件ToolStripMenuItem; + private ToolStripMenuItem 编辑ToolStripMenuItem; + private ToolStripMenuItem 视图ToolStripMenuItem; + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/Form1.cs b/Webview2WinFormsApp/Form1.cs new file mode 100644 index 0000000..e25aad7 --- /dev/null +++ b/Webview2WinFormsApp/Form1.cs @@ -0,0 +1,41 @@ +namespace Webview2WinFormsApp +{ + public partial class Form1 : Form + { + /// + /// https://www.bilibili.com/read/cv23844020/ + /// + private AutoAdaptWindowsSize autoSize; + public Form1() + { + InitializeComponent(); + autoSize = new AutoAdaptWindowsSize(this); + this.SizeChanged += Form1_SizeChanged; + } + + private void Form1_SizeChanged(object? sender, EventArgs e) + { + if (autoSize != null) // һжϣŲֲ100%ʱ򣬻ᱨ + { + autoSize.FormSizeChanged(); + } + } + + private void Form1_Load(object sender, EventArgs e) + { + webView21.Source = new Uri(AppDomain.CurrentDomain.BaseDirectory + "\\web\\index.html"); + } + + private void webView21_CoreWebView2InitializationCompleted(object sender, Microsoft.Web.WebView2.Core.CoreWebView2InitializationCompletedEventArgs e) + { + if (e.IsSuccess) + { + Console.WriteLine("webView21_CoreWebView2InitializationCompleted"); + var bridge = new Bridge(); + // + webView21.CoreWebView2.AddHostObjectToScript("bridge", bridge); + webView21.Source = new Uri(AppDomain.CurrentDomain.BaseDirectory + "\\web\\index.html"); + } + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/Form1.resx b/Webview2WinFormsApp/Form1.resx new file mode 100644 index 0000000..a0623c8 --- /dev/null +++ b/Webview2WinFormsApp/Form1.resx @@ -0,0 +1,123 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + 17, 17 + + \ No newline at end of file diff --git a/Webview2WinFormsApp/Form2.Designer.cs b/Webview2WinFormsApp/Form2.Designer.cs new file mode 100644 index 0000000..485c137 --- /dev/null +++ b/Webview2WinFormsApp/Form2.Designer.cs @@ -0,0 +1,61 @@ +namespace Webview2WinFormsApp +{ + partial class Form2 + { + /// + /// Required designer variable. + /// + private System.ComponentModel.IContainer components = null; + + /// + /// Clean up any resources being used. + /// + /// true if managed resources should be disposed; otherwise, false. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows Form Designer generated code + + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + panel1 = new Panel(); + SuspendLayout(); + // + // panel1 + // + panel1.AutoScroll = true; + panel1.Dock = DockStyle.Fill; + panel1.Location = new Point(0, 0); + panel1.Name = "panel1"; + panel1.Padding = new Padding(10); + panel1.Size = new Size(878, 699); + panel1.TabIndex = 0; + // + // Form2 + // + AutoScaleDimensions = new SizeF(7F, 17F); + AutoScaleMode = AutoScaleMode.Font; + BackColor = Color.White; + ClientSize = new Size(878, 699); + Controls.Add(panel1); + Name = "Form2"; + Text = "Form2"; + Load += Form2_Load; + ResumeLayout(false); + } + + #endregion + + private Panel panel1; + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/Form2.cs b/Webview2WinFormsApp/Form2.cs new file mode 100644 index 0000000..90b4761 --- /dev/null +++ b/Webview2WinFormsApp/Form2.cs @@ -0,0 +1,46 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using UtilLib; + +namespace Webview2WinFormsApp +{ + public partial class Form2 : Form + { + public Form2() + { + InitializeComponent(); + } + + private readonly int ItemHeight = 90; + private readonly List Items = new List(); + + private void Form2_Load(object sender, EventArgs e) + { + panel1.AutoScroll = true; + var result = API.GetProofreadResult(); + int index = 0; + foreach (var correct in result.CorrectedSet) + { + if (correct.Diffs != null) + { + foreach (var it in correct.Diffs) + { + ProofreadItem item = new ProofreadItem(); + item.SetProofreadItem(it); + Items.Add(item); + item.Location = new Point(10, (ItemHeight + 10) * index); + panel1.Controls.Add(item); + index++; + } + } + } + } + } +} diff --git a/Webview2WinFormsApp/Form2.resx b/Webview2WinFormsApp/Form2.resx new file mode 100644 index 0000000..af32865 --- /dev/null +++ b/Webview2WinFormsApp/Form2.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/Webview2WinFormsApp/Model.cs b/Webview2WinFormsApp/Model.cs new file mode 100644 index 0000000..779ad4f --- /dev/null +++ b/Webview2WinFormsApp/Model.cs @@ -0,0 +1,70 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace TestWordAddIn1 +{ + internal class Model + { + } + + internal class DiffItem + { + + } + internal class Correct + { + public string Key { get; set; } + public int Offset { get; set; } + public string New_text { get; set; } + public string Insert { get; set; } + public int Insert_len { get; set; } + + public List Diffs { get; set; } + } + + internal class ProofreadResult + { + public object AbnormalCount { get; set; } + public List CorrectedSet { get; set; } + public object History { get; set; } + + /* + "id": 1326, + "isBlackWord": true, + "isOrigin": 2, + "isWhiteWord": true, + "name": "失业在家的日子-最新", + "status": 3 + */ + public int Id { get; set; } + public bool IsBlackWord { get; set; } + public int IsOrigin { get; set; } + public bool IsWhiteWord { get; set; } + public int Status { get; set; } + public string Name { get; set; } + } + + internal class Response + { + public int Code { get; set; } + public string Msg { get; set; } + public T Data { get; set; } + } + + internal class WebActionMessage + { + public WebActionMessage() + { } + public WebActionMessage(string action, object data) + { + Action = action; + Data = data; + } + + public string Action { get; set; } + public object Data { get; set; } + } +} diff --git a/Webview2WinFormsApp/Program.cs b/Webview2WinFormsApp/Program.cs new file mode 100644 index 0000000..3a1fc05 --- /dev/null +++ b/Webview2WinFormsApp/Program.cs @@ -0,0 +1,17 @@ +namespace Webview2WinFormsApp +{ + internal static class Program + { + /// + /// The main entry point for the application. + /// + [STAThread] + static void Main() + { + // To customize application configuration such as set high DPI settings or default font, + // see https://aka.ms/applicationconfiguration. + ApplicationConfiguration.Initialize(); + Application.Run(new Form2()); + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/ProofreadItem.Designer.cs b/Webview2WinFormsApp/ProofreadItem.Designer.cs new file mode 100644 index 0000000..71211a8 --- /dev/null +++ b/Webview2WinFormsApp/ProofreadItem.Designer.cs @@ -0,0 +1,115 @@ +namespace Webview2WinFormsApp +{ + partial class ProofreadItem + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源，为 true；否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region 组件设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + origin = new Label(); + type = new Label(); + description = new Label(); + button1 = new Button(); + button2 = new Button(); + SuspendLayout(); + // + // origin + // + origin.AutoSize = true; + origin.Location = new Point(21, 17); + origin.Name = "origin"; + origin.Size = new Size(42, 17); + origin.TabIndex = 0; + origin.Text = "origin"; + // + // type + // + type.AutoSize = true; + type.Location = new Point(80, 18); + type.Name = "type"; + type.Size = new Size(33, 17); + type.TabIndex = 1; + type.Text = "type"; + // + // description + // + description.AutoSize = true; + description.Location = new Point(14, 48); + description.Name = "description"; + description.Size = new Size(73, 17); + description.TabIndex = 2; + description.Text = "description"; + // + // button1 + // + button1.BackgroundImage = Properties.Resources.check; + button1.BackgroundImageLayout = ImageLayout.Stretch; + button1.Cursor = Cursors.Hand; + button1.Location = new Point(269, 18); + button1.Name = "button1"; + button1.Size = new Size(26, 26); + button1.TabIndex = 3; + button1.UseVisualStyleBackColor = true; + // + // button2 + // + button2.BackgroundImage = Properties.Resources.minus_bold; + button2.BackgroundImageLayout = ImageLayout.Stretch; + button2.Cursor = Cursors.Hand; + button2.Location = new Point(301, 18); + button2.Name = "button2"; + button2.Size = new Size(26, 26); + button2.TabIndex = 4; + button2.UseVisualStyleBackColor = true; + // + // ProofreadItem + // + AutoScaleDimensions = new SizeF(7F, 17F); + AutoScaleMode = AutoScaleMode.Font; + BackColor = Color.WhiteSmoke; + Controls.Add(button2); + Controls.Add(button1); + Controls.Add(description); + Controls.Add(type); + Controls.Add(origin); + Name = "ProofreadItem"; + Size = new Size(350, 90); + Load += ProofreadItem_Load; + Click += ProofreadItem_Click; + MouseEnter += ProofreadItem_MouseEnter; + MouseLeave += ProofreadItem_MouseLeave; + ResumeLayout(false); + PerformLayout(); + } + + #endregion + + private Label origin; + private Label type; + private Label description; + private Button button1; + private Button button2; + } +} diff --git a/Webview2WinFormsApp/ProofreadItem.cs b/Webview2WinFormsApp/ProofreadItem.cs new file mode 100644 index 0000000..517d00a --- /dev/null +++ b/Webview2WinFormsApp/ProofreadItem.cs @@ -0,0 +1,82 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using UtilLib; + +namespace Webview2WinFormsApp +{ + public partial class ProofreadItem : UserControl + { + + private readonly Color BG_NORMAL = Color.WhiteSmoke; + private readonly Color BG_HOVER = Color.AliceBlue; + private readonly Color BG_ACTIVE = Color.AliceBlue; + public ProofreadItem() + { + InitializeComponent(); + this.BackColor = BG_NORMAL; + } + + private void ProofreadItem_MouseEnter(object sender, EventArgs e) + { + this.BackColor = BG_HOVER; + Console.WriteLine("ProofreadItem_MouseEnter"); + } + + private void ProofreadItem_MouseLeave(object sender, EventArgs e) + { + this.BackColor = BG_NORMAL; + Console.WriteLine("ProofreadItem_MouseLeave"); + } + + private void ProofreadItem_Click(object sender, EventArgs e) + { + this.BackColor = BG_ACTIVE; + Console.WriteLine("ProofreadItem_Click"); + } + + public void SetProofreadItem(DiffItem it) + { + var typeConfig = TypeConfig.Get(it.Type); + type.Text = typeConfig.Text; + type.Visible = false; + + if (it.Type == ProofreadType.blackWord + || it.Type == ProofreadType.blackWordBlock + || it.Type == ProofreadType.sensitive) + { + description.Text = "【敏感词】建议查看"; + } + else + { + if (it.Tag == "r") + { + origin.Text = it.Origin + ">" + it.Text; + description.Text = string.Format("【{0}】建议选用“{1}”", typeConfig.Text, it.Text); + } + else if (it.Tag == "i") + { + origin.Text = it.Text + " 新增"; + description.Text = string.Format("【{0}】建议新增", typeConfig.Text); + } + else + { + origin.Text = it.Origin + " 删除"; + description.Text = string.Format("【{0}】建议删除", typeConfig.Text); + } + } + + } + + private void ProofreadItem_Load(object sender, EventArgs e) + { + + } + } +} diff --git a/Webview2WinFormsApp/ProofreadItem.resx b/Webview2WinFormsApp/ProofreadItem.resx new file mode 100644 index 0000000..af32865 --- /dev/null +++ b/Webview2WinFormsApp/ProofreadItem.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/Webview2WinFormsApp/Properties/Resources.Designer.cs b/Webview2WinFormsApp/Properties/Resources.Designer.cs new file mode 100644 index 0000000..79e390d --- /dev/null +++ b/Webview2WinFormsApp/Properties/Resources.Designer.cs @@ -0,0 +1,83 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本:4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为，并且如果 +// 重新生成代码，这些更改将会丢失。 +// +//------------------------------------------------------------------------------ + +namespace Webview2WinFormsApp.Properties { + using System; + + + /// + /// 一个强类型的资源类，用于查找本地化的字符串等。 + /// + // 此类是由 StronglyTypedResourceBuilder + // 类通过类似于 ResGen 或 Visual Studio 的工具自动生成的。 + // 若要添加或移除成员，请编辑 .ResX 文件，然后重新运行 ResGen + // (以 /str 作为命令选项)，或重新生成 VS 项目。 + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() { + } + + /// + /// 返回此类使用的缓存的 ResourceManager 实例。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Webview2WinFormsApp.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// 重写当前线程的 CurrentUICulture 属性，对 + /// 使用此强类型资源类的所有资源查找执行重写。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap check { + get { + object obj = ResourceManager.GetObject("check", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + + /// + /// 查找 System.Drawing.Bitmap 类型的本地化资源。 + /// + internal static System.Drawing.Bitmap minus_bold { + get { + object obj = ResourceManager.GetObject("minus-bold", resourceCulture); + return ((System.Drawing.Bitmap)(obj)); + } + } + } +} diff --git a/Webview2WinFormsApp/Properties/Resources.resx b/Webview2WinFormsApp/Properties/Resources.resx new file mode 100644 index 0000000..03ed0f2 --- /dev/null +++ b/Webview2WinFormsApp/Properties/Resources.resx @@ -0,0 +1,127 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + + ..\Resources\check.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + + ..\Resources\minus-bold.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a + + \ No newline at end of file diff --git a/Webview2WinFormsApp/Resources/check.png b/Webview2WinFormsApp/Resources/check.png new file mode 100644 index 0000000..e6f7e50 Binary files /dev/null and b/Webview2WinFormsApp/Resources/check.png differ diff --git a/Webview2WinFormsApp/Resources/minus-bold.png b/Webview2WinFormsApp/Resources/minus-bold.png new file mode 100644 index 0000000..eabc9b5 Binary files /dev/null and b/Webview2WinFormsApp/Resources/minus-bold.png differ diff --git a/Webview2WinFormsApp/Webview2WinFormsApp.csproj b/Webview2WinFormsApp/Webview2WinFormsApp.csproj new file mode 100644 index 0000000..4401e67 --- /dev/null +++ b/Webview2WinFormsApp/Webview2WinFormsApp.csproj @@ -0,0 +1,44 @@ + + + + WinExe + net6.0-windows + enable + true + enable + + + + + + + + + Always + + + + + + + + + + + + + + True + True + Resources.resx + + + + + + ResXFileCodeGenerator + Resources.Designer.cs + + + + \ No newline at end of file diff --git a/Webview2WinFormsApp/Webview2WinFormsApp.csproj.user b/Webview2WinFormsApp/Webview2WinFormsApp.csproj.user new file mode 100644 index 0000000..a4af2c7 --- /dev/null +++ b/Webview2WinFormsApp/Webview2WinFormsApp.csproj.user @@ -0,0 +1,14 @@ + + + + + Form + + + Form + + + UserControl + + + \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/.NETCoreApp,Version=v6.0.AssemblyAttributes.cs b/Webview2WinFormsApp/obj/Debug/net6.0-windows/.NETCoreApp,Version=v6.0.AssemblyAttributes.cs new file mode 100644 index 0000000..ed92695 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/.NETCoreApp,Version=v6.0.AssemblyAttributes.cs @@ -0,0 +1,4 @@ +// +using System; +using System.Reflection; +[assembly: global::System.Runtime.Versioning.TargetFrameworkAttribute(".NETCoreApp,Version=v6.0", FrameworkDisplayName = ".NET 6.0")] diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfo.cs b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfo.cs new file mode 100644 index 0000000..7cf4576 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfo.cs @@ -0,0 +1,25 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本:4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为，并且如果 +// 重新生成代码，这些更改将会丢失。 +// +//------------------------------------------------------------------------------ + +using System; +using System.Reflection; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Webview2WinFormsApp")] +[assembly: System.Reflection.AssemblyConfigurationAttribute("Debug")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0.0")] +[assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0")] +[assembly: System.Reflection.AssemblyProductAttribute("Webview2WinFormsApp")] +[assembly: System.Reflection.AssemblyTitleAttribute("Webview2WinFormsApp")] +[assembly: System.Reflection.AssemblyVersionAttribute("1.0.0.0")] +[assembly: System.Runtime.Versioning.TargetPlatformAttribute("Windows7.0")] +[assembly: System.Runtime.Versioning.SupportedOSPlatformAttribute("Windows7.0")] + +// 由 MSBuild WriteCodeFragment 类生成。 + diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfoInputs.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfoInputs.cache new file mode 100644 index 0000000..514d878 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.AssemblyInfoInputs.cache @@ -0,0 +1 @@ +1a63871452e65bc94ef13afede3643178c1c9f7d diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form1.resources b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form1.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form1.resources differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form2.resources b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form2.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Form2.resources differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GeneratedMSBuildEditorConfig.editorconfig b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GeneratedMSBuildEditorConfig.editorconfig new file mode 100644 index 0000000..a0158b9 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GeneratedMSBuildEditorConfig.editorconfig @@ -0,0 +1,17 @@ +is_global = true +build_property.ApplicationManifest = +build_property.StartupObject = +build_property.ApplicationDefaultFont = +build_property.ApplicationHighDpiMode = +build_property.ApplicationUseCompatibleTextRendering = +build_property.ApplicationVisualStyles = +build_property.TargetFramework = net6.0-windows +build_property.TargetPlatformMinVersion = 7.0 +build_property.UsingMicrosoftNETSdkWeb = +build_property.ProjectTypeGuids = +build_property.InvariantGlobalization = +build_property.PlatformNeutralAssembly = +build_property.EnforceExtendedAnalyzerRules = +build_property._SupportedPlatformList = Linux,macOS,Windows +build_property.RootNamespace = Webview2WinFormsApp +build_property.ProjectDir = C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GlobalUsings.g.cs b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GlobalUsings.g.cs new file mode 100644 index 0000000..84bbb89 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.GlobalUsings.g.cs @@ -0,0 +1,10 @@ +// +global using global::System; +global using global::System.Collections.Generic; +global using global::System.Drawing; +global using global::System.IO; +global using global::System.Linq; +global using global::System.Net.Http; +global using global::System.Threading; +global using global::System.Threading.Tasks; +global using global::System.Windows.Forms; diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.ProofreadItem.resources b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.ProofreadItem.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.ProofreadItem.resources differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Properties.Resources.resources b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Properties.Resources.resources new file mode 100644 index 0000000..647c3e9 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.Properties.Resources.resources differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.assets.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.assets.cache new file mode 100644 index 0000000..6954e16 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.assets.cache differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.AssemblyReference.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.AssemblyReference.cache new file mode 100644 index 0000000..1cb6973 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.AssemblyReference.cache differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.BuildWithSkipAnalyzers b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.BuildWithSkipAnalyzers new file mode 100644 index 0000000..e69de29 diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.CopyComplete b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.CopyComplete new file mode 100644 index 0000000..e69de29 diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.CoreCompileInputs.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.CoreCompileInputs.cache new file mode 100644 index 0000000..3b5ff62 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.CoreCompileInputs.cache @@ -0,0 +1 @@ +4cd1f286d0017333667f4d97371733f92f4cbe53 diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.FileListAbsolute.txt b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..be3c6a5 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.FileListAbsolute.txt @@ -0,0 +1,33 @@ +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\runtimes\win-x86\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\runtimes\win-x64\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\runtimes\win-arm64\native\WebView2Loader.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Webview2WinFormsApp.exe +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\web\index.html +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Webview2WinFormsApp.deps.json +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Webview2WinFormsApp.runtimeconfig.json +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Webview2WinFormsApp.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Webview2WinFormsApp.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Microsoft.Web.WebView2.Core.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Microsoft.Web.WebView2.WinForms.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Microsoft.Web.WebView2.Wpf.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.csproj.AssemblyReference.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.Form1.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.csproj.GenerateResource.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.GeneratedMSBuildEditorConfig.editorconfig +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.AssemblyInfoInputs.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.AssemblyInfo.cs +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.csproj.CoreCompileInputs.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.csproj.CopyComplete +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\refint\Webview2WinFormsApp.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.genruntimeconfig.cache +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\ref\Webview2WinFormsApp.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.Form2.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.ProofreadItem.resources +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\UtilLib.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Newtonsoft.Json.dll +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\UtilLib.pdb +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\UtilLib.dll.config +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\bin\Debug\net6.0-windows\Newtonsoft.Json.xml +C:\Users\home-dev\source\repos\TestWordAddIn1\Webview2WinFormsApp\obj\Debug\net6.0-windows\Webview2WinFormsApp.Properties.Resources.resources diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.GenerateResource.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.GenerateResource.cache new file mode 100644 index 0000000..cad455d Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.csproj.GenerateResource.cache differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.deps.json b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.deps.json new file mode 100644 index 0000000..44ac1c3 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.deps.json @@ -0,0 +1,53 @@ +{ + "runtimeTarget": { + "name": ".NETCoreApp,Version=v6.0", + "signature": "" + }, + "compilationOptions": {}, + "targets": { + ".NETCoreApp,Version=v6.0": { + "Microsoft.Web.WebView2/1.0.2151.40": { + "runtime": { + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Core.dll": { + "assemblyVersion": "1.0.2151.40", + "fileVersion": "1.0.2151.40" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.WinForms.dll": { + "assemblyVersion": "1.0.2151.40", + "fileVersion": "1.0.2151.40" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Wpf.dll": { + "assemblyVersion": "1.0.2151.40", + "fileVersion": "1.0.2151.40" + } + }, + "runtimeTargets": { + "runtimes/win-arm64/native/WebView2Loader.dll": { + "rid": "win-arm64", + "assetType": "native", + "fileVersion": "1.0.2151.40" + }, + "runtimes/win-x64/native/WebView2Loader.dll": { + "rid": "win-x64", + "assetType": "native", + "fileVersion": "1.0.2151.40" + }, + "runtimes/win-x86/native/WebView2Loader.dll": { + "rid": "win-x86", + "assetType": "native", + "fileVersion": "1.0.2151.40" + } + } + } + } + }, + "libraries": { + "Microsoft.Web.WebView2/1.0.2151.40": { + "type": "package", + "serviceable": true, + "sha512": "sha512-OPWjZVJvYhDm4Jq+7QdsQfEgv2QHrkaqUkdk4i9FahatsOJ4cIaVLfnDHGsKjcxGqCVX+Lo4mi4Lqh5hcgfsdw==", + "path": "microsoft.web.webview2/1.0.2151.40", + "hashPath": "microsoft.web.webview2.1.0.2151.40.nupkg.sha512" + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.runtimeconfig.json b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.runtimeconfig.json new file mode 100644 index 0000000..ea1f944 --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.designer.runtimeconfig.json @@ -0,0 +1,23 @@ +{ + "runtimeOptions": { + "tfm": "net6.0", + "frameworks": [ + { + "name": "Microsoft.NETCore.App", + "version": "6.0.0" + }, + { + "name": "Microsoft.WindowsDesktop.App", + "version": "6.0.0" + } + ], + "additionalProbingPaths": [ + "C:\\Users\\home-dev\\.dotnet\\store\\|arch|\\|tfm|", + "C:\\Users\\home-dev\\.nuget\\packages", + "C:\\Program Files (x86)\\Microsoft Visual Studio\\Shared\\NuGetPackages" + ], + "configProperties": { + "Microsoft.NETCore.DotNetHostPolicy.SetAppPaths": true + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.dll b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.dll new file mode 100644 index 0000000..e6f8650 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.dll differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.genruntimeconfig.cache b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.genruntimeconfig.cache new file mode 100644 index 0000000..de430dc --- /dev/null +++ b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.genruntimeconfig.cache @@ -0,0 +1 @@ +f35f4eea98af1b290b9a74644878e14f5712b444 diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.pdb b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.pdb new file mode 100644 index 0000000..b438665 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/Webview2WinFormsApp.pdb differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/apphost.exe b/Webview2WinFormsApp/obj/Debug/net6.0-windows/apphost.exe new file mode 100644 index 0000000..1d5190b Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/apphost.exe differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/ref/Webview2WinFormsApp.dll b/Webview2WinFormsApp/obj/Debug/net6.0-windows/ref/Webview2WinFormsApp.dll new file mode 100644 index 0000000..b8dbea4 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/ref/Webview2WinFormsApp.dll differ diff --git a/Webview2WinFormsApp/obj/Debug/net6.0-windows/refint/Webview2WinFormsApp.dll b/Webview2WinFormsApp/obj/Debug/net6.0-windows/refint/Webview2WinFormsApp.dll new file mode 100644 index 0000000..b8dbea4 Binary files /dev/null and b/Webview2WinFormsApp/obj/Debug/net6.0-windows/refint/Webview2WinFormsApp.dll differ diff --git a/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.dgspec.json b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.dgspec.json new file mode 100644 index 0000000..ad3bba2 --- /dev/null +++ b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.dgspec.json @@ -0,0 +1,95 @@ +{ + "format": 1, + "restore": { + "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj": {} + }, + "projects": { + "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj": { + "restore": { + "projectUniqueName": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj", + "projectName": "UtilLib", + "projectPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj", + "frameworks": { + "net462": { + "projectReferences": {} + } + } + }, + "frameworks": { + "net462": {} + } + }, + "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj": { + "version": "1.0.0", + "restore": { + "projectUniqueName": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj", + "projectName": "Webview2WinFormsApp", + "projectPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj", + "packagesPath": "C:\\Users\\home-dev\\.nuget\\packages\\", + "outputPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\obj\\", + "projectStyle": "PackageReference", + "fallbackFolders": [ + "C:\\Program Files (x86)\\Microsoft Visual Studio\\Shared\\NuGetPackages" + ], + "configFilePaths": [ + "C:\\Users\\home-dev\\AppData\\Roaming\\NuGet\\NuGet.Config", + "C:\\Program Files (x86)\\NuGet\\Config\\Microsoft.VisualStudio.FallbackLocation.config", + "C:\\Program Files (x86)\\NuGet\\Config\\Microsoft.VisualStudio.Offline.config" + ], + "originalTargetFrameworks": [ + "net6.0-windows" + ], + "sources": { + "C:\\Program Files (x86)\\Microsoft SDKs\\NuGetPackages\\": {}, + "https://api.nuget.org/v3/index.json": {} + }, + "frameworks": { + "net6.0-windows7.0": { + "targetAlias": "net6.0-windows", + "projectReferences": { + "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj": { + "projectPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj" + } + } + } + }, + "warningProperties": { + "warnAsError": [ + "NU1605" + ] + } + }, + "frameworks": { + "net6.0-windows7.0": { + "targetAlias": "net6.0-windows", + "dependencies": { + "Microsoft.Web.WebView2": { + "target": "Package", + "version": "[1.0.2151.40, )" + } + }, + "imports": [ + "net461", + "net462", + "net47", + "net471", + "net472", + "net48", + "net481" + ], + "assetTargetFallback": true, + "warn": true, + "frameworkReferences": { + "Microsoft.NETCore.App": { + "privateAssets": "all" + }, + "Microsoft.WindowsDesktop.App.WindowsForms": { + "privateAssets": "none" + } + }, + "runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\7.0.403\\RuntimeIdentifierGraph.json" + } + } + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.props b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.props new file mode 100644 index 0000000..1ff5c3f --- /dev/null +++ b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.props @@ -0,0 +1,19 @@ + + + + True + NuGet + $(MSBuildThisFileDirectory)project.assets.json + $(UserProfile)\.nuget\packages\ + C:\Users\home-dev\.nuget\packages\;C:\Program Files (x86)\Microsoft Visual Studio\Shared\NuGetPackages + PackageReference + 6.7.0 + + + + + + + C:\Users\home-dev\.nuget\packages\microsoft.web.webview2\1.0.2151.40 + + \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.targets b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.targets new file mode 100644 index 0000000..17eb77a --- /dev/null +++ b/Webview2WinFormsApp/obj/Webview2WinFormsApp.csproj.nuget.g.targets @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/project.assets.json b/Webview2WinFormsApp/obj/project.assets.json new file mode 100644 index 0000000..b2fff66 --- /dev/null +++ b/Webview2WinFormsApp/obj/project.assets.json @@ -0,0 +1,239 @@ +{ + "version": 3, + "targets": { + "net6.0-windows7.0": { + "Microsoft.Web.WebView2/1.0.2151.40": { + "type": "package", + "compile": { + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Core.dll": { + "related": ".xml" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.WinForms.dll": { + "related": ".xml" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Wpf.dll": { + "related": ".xml" + } + }, + "runtime": { + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Core.dll": { + "related": ".xml" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.WinForms.dll": { + "related": ".xml" + }, + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Wpf.dll": { + "related": ".xml" + } + }, + "build": { + "build/Microsoft.Web.WebView2.targets": {} + }, + "runtimeTargets": { + "runtimes/win-arm64/native/WebView2Loader.dll": { + "assetType": "native", + "rid": "win-arm64" + }, + "runtimes/win-x64/native/WebView2Loader.dll": { + "assetType": "native", + "rid": "win-x64" + }, + "runtimes/win-x86/native/WebView2Loader.dll": { + "assetType": "native", + "rid": "win-x86" + } + } + }, + "UtilLib/1.0.0": { + "type": "project", + "compile": { + "bin/placeholder/UtilLib.dll": {} + }, + "runtime": { + "bin/placeholder/UtilLib.dll": {} + } + } + } + }, + "libraries": { + "Microsoft.Web.WebView2/1.0.2151.40": { + "sha512": "OPWjZVJvYhDm4Jq+7QdsQfEgv2QHrkaqUkdk4i9FahatsOJ4cIaVLfnDHGsKjcxGqCVX+Lo4mi4Lqh5hcgfsdw==", + "type": "package", + "path": "microsoft.web.webview2/1.0.2151.40", + "hasTools": true, + "files": [ + ".nupkg.metadata", + ".signature.p7s", + "LICENSE.txt", + "NOTICE.txt", + "WebView2.idl", + "WebView2.tlb", + "build/Common.targets", + "build/Microsoft.Web.WebView2.targets", + "build/WebView2Rules.Project.xml", + "build/native/Microsoft.Web.WebView2.targets", + "build/native/arm64/WebView2Loader.dll", + "build/native/arm64/WebView2Loader.dll.lib", + "build/native/arm64/WebView2LoaderStatic.lib", + "build/native/include-winrt/WebView2Interop.h", + "build/native/include-winrt/WebView2Interop.idl", + "build/native/include-winrt/WebView2Interop.tlb", + "build/native/include/WebView2.h", + "build/native/include/WebView2EnvironmentOptions.h", + "build/native/x64/WebView2Loader.dll", + "build/native/x64/WebView2Loader.dll.lib", + "build/native/x64/WebView2LoaderStatic.lib", + "build/native/x86/WebView2Loader.dll", + "build/native/x86/WebView2Loader.dll.lib", + "build/native/x86/WebView2LoaderStatic.lib", + "build/wv2winrt.targets", + "lib/Microsoft.Web.WebView2.Core.winmd", + "lib/net45/Microsoft.Web.WebView2.Core.dll", + "lib/net45/Microsoft.Web.WebView2.Core.xml", + "lib/net45/Microsoft.Web.WebView2.WinForms.dll", + "lib/net45/Microsoft.Web.WebView2.WinForms.xml", + "lib/net45/Microsoft.Web.WebView2.Wpf.dll", + "lib/net45/Microsoft.Web.WebView2.Wpf.xml", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Core.dll", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Core.xml", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.WinForms.dll", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.WinForms.xml", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Wpf.dll", + "lib/netcoreapp3.0/Microsoft.Web.WebView2.Wpf.xml", + "microsoft.web.webview2.1.0.2151.40.nupkg.sha512", + "microsoft.web.webview2.nuspec", + "runtimes/win-arm64/native/WebView2Loader.dll", + "runtimes/win-arm64/native_uap/Microsoft.Web.WebView2.Core.dll", + "runtimes/win-x64/native/WebView2Loader.dll", + "runtimes/win-x64/native_uap/Microsoft.Web.WebView2.Core.dll", + "runtimes/win-x86/native/WebView2Loader.dll", + "runtimes/win-x86/native_uap/Microsoft.Web.WebView2.Core.dll", + "tools/VisualStudioToolsManifest.xml", + "tools/wv2winrt/Antlr3.Runtime.dll", + "tools/wv2winrt/Antlr4.StringTemplate.dll", + "tools/wv2winrt/System.Buffers.dll", + "tools/wv2winrt/System.CommandLine.DragonFruit.dll", + "tools/wv2winrt/System.CommandLine.Rendering.dll", + "tools/wv2winrt/System.CommandLine.dll", + "tools/wv2winrt/System.Memory.dll", + "tools/wv2winrt/System.Numerics.Vectors.dll", + "tools/wv2winrt/System.Runtime.CompilerServices.Unsafe.dll", + "tools/wv2winrt/codegen_util.dll", + "tools/wv2winrt/concrt140_app.dll", + "tools/wv2winrt/cs/System.CommandLine.resources.dll", + "tools/wv2winrt/de/System.CommandLine.resources.dll", + "tools/wv2winrt/es/System.CommandLine.resources.dll", + "tools/wv2winrt/fr/System.CommandLine.resources.dll", + "tools/wv2winrt/it/System.CommandLine.resources.dll", + "tools/wv2winrt/ja/System.CommandLine.resources.dll", + "tools/wv2winrt/ko/System.CommandLine.resources.dll", + "tools/wv2winrt/msvcp140_1_app.dll", + "tools/wv2winrt/msvcp140_2_app.dll", + "tools/wv2winrt/msvcp140_app.dll", + "tools/wv2winrt/pl/System.CommandLine.resources.dll", + "tools/wv2winrt/pt-BR/System.CommandLine.resources.dll", + "tools/wv2winrt/ru/System.CommandLine.resources.dll", + "tools/wv2winrt/tr/System.CommandLine.resources.dll", + "tools/wv2winrt/type_hierarchy.dll", + "tools/wv2winrt/vcamp140_app.dll", + "tools/wv2winrt/vccorlib140_app.dll", + "tools/wv2winrt/vcomp140_app.dll", + "tools/wv2winrt/vcruntime140_app.dll", + "tools/wv2winrt/winrt_winmd.dll", + "tools/wv2winrt/winrt_winmd.winmd", + "tools/wv2winrt/wv2winrt.exe", + "tools/wv2winrt/wv2winrt.exe.config", + "tools/wv2winrt/wv2winrt.xml", + "tools/wv2winrt/zh-Hans/System.CommandLine.resources.dll", + "tools/wv2winrt/zh-Hant/System.CommandLine.resources.dll" + ] + }, + "UtilLib/1.0.0": { + "type": "project", + "path": "../UtilLib/UtilLib.csproj", + "msbuildProject": "../UtilLib/UtilLib.csproj" + } + }, + "projectFileDependencyGroups": { + "net6.0-windows7.0": [ + "Microsoft.Web.WebView2 >= 1.0.2151.40", + "UtilLib >= 1.0.0" + ] + }, + "packageFolders": { + "C:\\Users\\home-dev\\.nuget\\packages\\": {}, + "C:\\Program Files (x86)\\Microsoft Visual Studio\\Shared\\NuGetPackages": {} + }, + "project": { + "version": "1.0.0", + "restore": { + "projectUniqueName": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj", + "projectName": "Webview2WinFormsApp", + "projectPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj", + "packagesPath": "C:\\Users\\home-dev\\.nuget\\packages\\", + "outputPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\obj\\", + "projectStyle": "PackageReference", + "fallbackFolders": [ + "C:\\Program Files (x86)\\Microsoft Visual Studio\\Shared\\NuGetPackages" + ], + "configFilePaths": [ + "C:\\Users\\home-dev\\AppData\\Roaming\\NuGet\\NuGet.Config", + "C:\\Program Files (x86)\\NuGet\\Config\\Microsoft.VisualStudio.FallbackLocation.config", + "C:\\Program Files (x86)\\NuGet\\Config\\Microsoft.VisualStudio.Offline.config" + ], + "originalTargetFrameworks": [ + "net6.0-windows" + ], + "sources": { + "C:\\Program Files (x86)\\Microsoft SDKs\\NuGetPackages\\": {}, + "https://api.nuget.org/v3/index.json": {} + }, + "frameworks": { + "net6.0-windows7.0": { + "targetAlias": "net6.0-windows", + "projectReferences": { + "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj": { + "projectPath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\UtilLib\\UtilLib.csproj" + } + } + } + }, + "warningProperties": { + "warnAsError": [ + "NU1605" + ] + } + }, + "frameworks": { + "net6.0-windows7.0": { + "targetAlias": "net6.0-windows", + "dependencies": { + "Microsoft.Web.WebView2": { + "target": "Package", + "version": "[1.0.2151.40, )" + } + }, + "imports": [ + "net461", + "net462", + "net47", + "net471", + "net472", + "net48", + "net481" + ], + "assetTargetFallback": true, + "warn": true, + "frameworkReferences": { + "Microsoft.NETCore.App": { + "privateAssets": "all" + }, + "Microsoft.WindowsDesktop.App.WindowsForms": { + "privateAssets": "none" + } + }, + "runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\7.0.403\\RuntimeIdentifierGraph.json" + } + } + } +} \ No newline at end of file diff --git a/Webview2WinFormsApp/obj/project.nuget.cache b/Webview2WinFormsApp/obj/project.nuget.cache new file mode 100644 index 0000000..f578a34 --- /dev/null +++ b/Webview2WinFormsApp/obj/project.nuget.cache @@ -0,0 +1,10 @@ +{ + "version": 2, + "dgSpecHash": "VbcSSxKHafFhICMk5dWbDm0xV6C//86LQfN+t+JNJ5vTAAFzqkvWphTqxcpwoKnph6ZvpsnWqJ0UPmP5K+Yrdw==", + "success": true, + "projectFilePath": "C:\\Users\\home-dev\\source\\repos\\TestWordAddIn1\\Webview2WinFormsApp\\Webview2WinFormsApp.csproj", + "expectedPackageFiles": [ + "C:\\Users\\home-dev\\.nuget\\packages\\microsoft.web.webview2\\1.0.2151.40\\microsoft.web.webview2.1.0.2151.40.nupkg.sha512" + ], + "logs": [] +} \ No newline at end of file diff --git a/Webview2WinFormsApp/web/index.html b/Webview2WinFormsApp/web/index.html new file mode 100644 index 0000000..b3d7072 --- /dev/null +++ b/Webview2WinFormsApp/web/index.html @@ -0,0 +1,24 @@ + + + + test + + + + + + + + \ No newline at end of file diff --git a/packages/Microsoft.Web.WebView2.1.0.2151.40/.signature.p7s b/packages/Microsoft.Web.WebView2.1.0.2151.40/.signature.p7s new file mode 100644 index 0000000..c9e876a Binary files /dev/null and b/packages/Microsoft.Web.WebView2.1.0.2151.40/.signature.p7s differ diff --git a/packages/Microsoft.Web.WebView2.1.0.2151.40/LICENSE.txt b/packages/Microsoft.Web.WebView2.1.0.2151.40/LICENSE.txt new file mode 100644 index 0000000..45f0297 --- /dev/null +++ b/packages/Microsoft.Web.WebView2.1.0.2151.40/LICENSE.txt @@ -0,0 +1,27 @@ +Copyright (C) Microsoft Corporation. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * The name of Microsoft Corporation, or the names of its contributors +may not be used to endorse or promote products derived from this +software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/packages/Microsoft.Web.WebView2.1.0.2151.40/Microsoft.Web.WebView2.1.0.2151.40.nupkg b/packages/Microsoft.Web.WebView2.1.0.2151.40/Microsoft.Web.WebView2.1.0.2151.40.nupkg new file mode 100644 index 0000000..1c68142 Binary files /dev/null and b/packages/Microsoft.Web.WebView2.1.0.2151.40/Microsoft.Web.WebView2.1.0.2151.40.nupkg differ diff --git a/packages/Microsoft.Web.WebView2.1.0.2151.40/NOTICE.txt b/packages/Microsoft.Web.WebView2.1.0.2151.40/NOTICE.txt new file mode 100644 index 0000000..bb64ba3 --- /dev/null +++ b/packages/Microsoft.Web.WebView2.1.0.2151.40/NOTICE.txt @@ -0,0 +1,85 @@ +NOTICES AND INFORMATION +Do Not Translate or Localize + +This software incorporates material from third parties. Microsoft makes certain +open source code available at https://3rdpartysource.microsoft.com, or you may +send a check or money order for US $5.00, including the product name, the open +source component name, and version number, to: + +Source Code Compliance Team +Microsoft Corporation +One Microsoft Way +Redmond, WA 98052 +USA + +Notwithstanding any other terms, you may reverse engineer this software to the +extent required to debug changes to any libraries licensed under the GNU Lesser +General Public License. + +---------------------------------------------------------------- + +Antlr3.Runtime 3.5.2-rc1 - BSD 3-Clause + +[The "BSD license"] +Copyright (c) 2011 The ANTLR Project +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +--------------------------------------------------------- + +--------------------------------------------------------- + +StringTemplate4 4.0.9-rc1 - BSD 3-Clause + +[The "BSD license"] +Copyright (c) 2011 The ANTLR Project +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +--------------------------------------------------------- diff --git a/packages/Microsoft.Web.WebView2.1.0.2151.40/WebView2.idl b/packages/Microsoft.Web.WebView2.1.0.2151.40/WebView2.idl new file mode 100644 index 0000000..21a3fcf --- /dev/null +++ b/packages/Microsoft.Web.WebView2.1.0.2151.40/WebView2.idl @@ -0,0 +1,8940 @@ +// Copyright (C) Microsoft Corporation. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import "objidl.idl"; +import "oaidl.idl"; +import "EventToken.idl"; + +[uuid(26d34152-879f-4065-bea2-3daa2cfadfb8), version(1.0)] +library WebView2 { + +// Interface forward declarations + +interface ICoreWebView2AcceleratorKeyPressedEventArgs; +interface ICoreWebView2AcceleratorKeyPressedEventHandler; +interface ICoreWebView2AddScriptToExecuteOnDocumentCreatedCompletedHandler; +interface ICoreWebView2CallDevToolsProtocolMethodCompletedHandler; +interface ICoreWebView2CapturePreviewCompletedHandler; +interface ICoreWebView2; +interface ICoreWebView2_2; +interface ICoreWebView2_3; +interface ICoreWebView2_4; +interface ICoreWebView2_5; +interface ICoreWebView2_6; +interface ICoreWebView2_7; +interface ICoreWebView2_8; +interface ICoreWebView2_9; +interface ICoreWebView2_10; +interface ICoreWebView2_11; +interface ICoreWebView2_12; +interface ICoreWebView2_13; +interface ICoreWebView2_14; +interface ICoreWebView2_15; +interface ICoreWebView2_16; +interface ICoreWebView2_17; +interface ICoreWebView2_18; +interface ICoreWebView2BasicAuthenticationRequestedEventArgs; +interface ICoreWebView2BasicAuthenticationRequestedEventHandler; +interface ICoreWebView2BasicAuthenticationResponse; +interface ICoreWebView2BrowserProcessExitedEventArgs; +interface ICoreWebView2BrowserProcessExitedEventHandler; +interface ICoreWebView2BytesReceivedChangedEventHandler; +interface ICoreWebView2CompositionController; +interface ICoreWebView2CompositionController2; +interface ICoreWebView2CompositionController3; +interface ICoreWebView2Controller; +interface ICoreWebView2Controller2; +interface ICoreWebView2Controller3; +interface ICoreWebView2Controller4; +interface ICoreWebView2ControllerOptions; +interface ICoreWebView2ControllerOptions2; +interface ICoreWebView2ContentLoadingEventArgs; +interface ICoreWebView2ContentLoadingEventHandler; +interface ICoreWebView2ContextMenuRequestedEventArgs; +interface ICoreWebView2ContextMenuRequestedEventHandler; +interface ICoreWebView2Cookie; +interface ICoreWebView2CookieList; +interface ICoreWebView2CookieManager; +interface ICoreWebView2Certificate; +interface ICoreWebView2ClientCertificate; +interface ICoreWebView2StringCollection; +interface ICoreWebView2ClearBrowsingDataCompletedHandler; +interface ICoreWebView2ClientCertificateCollection; +interface ICoreWebView2ClientCertificateRequestedEventArgs; +interface ICoreWebView2ClientCertificateRequestedEventHandler; +interface ICoreWebView2ContextMenuItem; +interface ICoreWebView2ContextMenuItemCollection; +interface ICoreWebView2ContextMenuRequestedEventArgs; +interface ICoreWebView2ContextMenuRequestedEventHandler; +interface ICoreWebView2ContextMenuTarget; +interface ICoreWebView2ClearServerCertificateErrorActionsCompletedHandler; +interface ICoreWebView2CreateCoreWebView2CompositionControllerCompletedHandler; +interface ICoreWebView2CreateCoreWebView2ControllerCompletedHandler; +interface ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler; +interface ICoreWebView2ContainsFullScreenElementChangedEventHandler; +interface ICoreWebView2CursorChangedEventHandler; +interface ICoreWebView2CustomItemSelectedEventHandler; +interface ICoreWebView2CustomSchemeRegistration; +interface ICoreWebView2DocumentTitleChangedEventHandler; +interface ICoreWebView2DOMContentLoadedEventArgs; +interface ICoreWebView2DOMContentLoadedEventHandler; +interface ICoreWebView2Deferral; +interface ICoreWebView2DevToolsProtocolEventReceivedEventArgs; +interface ICoreWebView2DevToolsProtocolEventReceivedEventArgs2; +interface ICoreWebView2DevToolsProtocolEventReceivedEventHandler; +interface ICoreWebView2DevToolsProtocolEventReceiver; +interface ICoreWebView2DownloadOperation; +interface ICoreWebView2DownloadStartingEventArgs; +interface ICoreWebView2DownloadStartingEventHandler; +interface ICoreWebView2Environment; +interface ICoreWebView2Environment2; +interface ICoreWebView2Environment3; +interface ICoreWebView2Environment4; +interface ICoreWebView2Environment5; +interface ICoreWebView2Environment6; +interface ICoreWebView2Environment7; +interface ICoreWebView2Environment8; +interface ICoreWebView2Environment9; +interface ICoreWebView2Environment10; +interface ICoreWebView2Environment11; +interface ICoreWebView2Environment12; +interface ICoreWebView2Environment13; +interface ICoreWebView2EnvironmentOptions; +interface ICoreWebView2EnvironmentOptions2; +interface ICoreWebView2EnvironmentOptions3; +interface ICoreWebView2EnvironmentOptions4; +interface ICoreWebView2EnvironmentOptions5; +interface ICoreWebView2EstimatedEndTimeChangedEventHandler; +interface ICoreWebView2ExecuteScriptCompletedHandler; +interface ICoreWebView2Frame; +interface ICoreWebView2Frame2; +interface ICoreWebView2Frame3; +interface ICoreWebView2Frame4; +interface ICoreWebView2FrameContentLoadingEventHandler; +interface ICoreWebView2FrameCreatedEventArgs; +interface ICoreWebView2FrameCreatedEventHandler; +interface ICoreWebView2FrameDestroyedEventHandler; +interface ICoreWebView2FrameDOMContentLoadedEventHandler; +interface ICoreWebView2FrameNameChangedEventHandler; +interface ICoreWebView2FrameNavigationCompletedEventHandler; +interface ICoreWebView2FrameNavigationStartingEventHandler; +interface ICoreWebView2FramePermissionRequestedEventHandler; +interface ICoreWebView2FrameWebMessageReceivedEventHandler; +interface ICoreWebView2FrameInfo; +interface ICoreWebView2FrameInfoCollection; +interface ICoreWebView2FrameInfoCollectionIterator; +interface ICoreWebView2FocusChangedEventHandler; +interface ICoreWebView2GetCookiesCompletedHandler; +interface ICoreWebView2GetNonDefaultPermissionSettingsCompletedHandler; +interface ICoreWebView2HistoryChangedEventHandler; +interface ICoreWebView2HttpHeadersCollectionIterator; +interface ICoreWebView2HttpRequestHeaders; +interface ICoreWebView2HttpResponseHeaders; +interface ICoreWebView2IsDefaultDownloadDialogOpenChangedEventHandler; +interface ICoreWebView2LaunchingExternalUriSchemeEventArgs; +interface ICoreWebView2LaunchingExternalUriSchemeEventHandler; +interface ICoreWebView2MoveFocusRequestedEventArgs; +interface ICoreWebView2MoveFocusRequestedEventHandler; +interface ICoreWebView2NavigationCompletedEventArgs; +interface ICoreWebView2NavigationCompletedEventArgs2; +interface ICoreWebView2NavigationCompletedEventHandler; +interface ICoreWebView2NavigationStartingEventArgs; +interface ICoreWebView2NavigationStartingEventArgs2; +interface ICoreWebView2NavigationStartingEventArgs3; +interface ICoreWebView2NavigationStartingEventHandler; +interface ICoreWebView2NewBrowserVersionAvailableEventHandler; +interface ICoreWebView2NewWindowRequestedEventArgs; +interface ICoreWebView2NewWindowRequestedEventArgs2; +interface ICoreWebView2NewWindowRequestedEventArgs3; +interface ICoreWebView2NewWindowRequestedEventHandler; +interface ICoreWebView2PermissionRequestedEventArgs; +interface ICoreWebView2PermissionRequestedEventArgs2; +interface ICoreWebView2PermissionRequestedEventArgs3; +interface ICoreWebView2PermissionRequestedEventHandler; +interface ICoreWebView2PermissionSettingCollectionView; +interface ICoreWebView2PermissionSetting; +interface ICoreWebView2PointerInfo; +interface ICoreWebView2PrintSettings; +interface ICoreWebView2PrintSettings2; +interface ICoreWebView2PrintToPdfCompletedHandler; +interface ICoreWebView2PrintCompletedHandler; +interface ICoreWebView2PrintToPdfStreamCompletedHandler; +interface ICoreWebView2ProcessFailedEventArgs; +interface ICoreWebView2ProcessFailedEventArgs2; +interface ICoreWebView2ProcessFailedEventHandler; +interface ICoreWebView2Profile; +interface ICoreWebView2Profile2; +interface ICoreWebView2Profile3; +interface ICoreWebView2Profile4; +interface ICoreWebView2Profile5; +interface ICoreWebView2Profile6; +interface ICoreWebView2RasterizationScaleChangedEventHandler; +interface ICoreWebView2ServerCertificateErrorDetectedEventArgs; +interface ICoreWebView2ServerCertificateErrorDetectedEventHandler; +interface ICoreWebView2SetPermissionStateCompletedHandler; +interface ICoreWebView2ScriptDialogOpeningEventArgs; +interface ICoreWebView2ScriptDialogOpeningEventHandler; +interface ICoreWebView2Settings; +interface ICoreWebView2Settings2; +interface ICoreWebView2Settings3; +interface ICoreWebView2Settings4; +interface ICoreWebView2Settings5; +interface ICoreWebView2Settings6; +interface ICoreWebView2Settings7; +interface ICoreWebView2Settings8; +interface ICoreWebView2SharedBuffer; +interface ICoreWebView2SourceChangedEventArgs; +interface ICoreWebView2SourceChangedEventHandler; +interface ICoreWebView2StateChangedEventHandler; +interface ICoreWebView2StatusBarTextChangedEventHandler; +interface ICoreWebView2TrySuspendCompletedHandler; +interface ICoreWebView2WebMessageReceivedEventArgs; +interface ICoreWebView2WebMessageReceivedEventHandler; +interface ICoreWebView2WebResourceRequest; +interface ICoreWebView2WebResourceRequestedEventArgs; +interface ICoreWebView2WebResourceRequestedEventHandler; +interface ICoreWebView2WebResourceResponse; +interface ICoreWebView2WebResourceResponseReceivedEventHandler; +interface ICoreWebView2WebResourceResponseReceivedEventArgs; +interface ICoreWebView2WebResourceResponseView; +interface ICoreWebView2WebResourceResponseViewGetContentCompletedHandler; +interface ICoreWebView2WindowCloseRequestedEventHandler; +interface ICoreWebView2WindowFeatures; +interface ICoreWebView2ZoomFactorChangedEventHandler; +interface ICoreWebView2IsMutedChangedEventHandler; +interface ICoreWebView2IsDocumentPlayingAudioChangedEventHandler; +interface ICoreWebView2ProcessInfo; +interface ICoreWebView2ProcessInfoCollection; +interface ICoreWebView2ProcessInfosChangedEventHandler; +interface ICoreWebView2FaviconChangedEventHandler; +interface ICoreWebView2GetFaviconCompletedHandler; + +// Enums and structs + +/// Specifies the image format for the `ICoreWebView2::CapturePreview` method. + +[v1_enum] +typedef enum COREWEBVIEW2_CAPTURE_PREVIEW_IMAGE_FORMAT { + + /// Indicates that the PNG image format is used. + + COREWEBVIEW2_CAPTURE_PREVIEW_IMAGE_FORMAT_PNG, + + /// Indicates the JPEG image format is used. + + COREWEBVIEW2_CAPTURE_PREVIEW_IMAGE_FORMAT_JPEG, +} COREWEBVIEW2_CAPTURE_PREVIEW_IMAGE_FORMAT; + +/// Kind of cookie SameSite status used in the ICoreWebView2Cookie interface. +/// These fields match those as specified in https://developer.mozilla.org/docs/Web/HTTP/Cookies#. +/// Learn more about SameSite cookies here: https://tools.ietf.org/html/draft-west-first-party-cookies-07 +[v1_enum] +typedef enum COREWEBVIEW2_COOKIE_SAME_SITE_KIND { + /// None SameSite type. No restrictions on cross-site requests. + COREWEBVIEW2_COOKIE_SAME_SITE_KIND_NONE, + /// Lax SameSite type. The cookie will be sent with "same-site" requests, and with "cross-site" top level navigation. + COREWEBVIEW2_COOKIE_SAME_SITE_KIND_LAX, + /// Strict SameSite type. The cookie will only be sent along with "same-site" requests. + COREWEBVIEW2_COOKIE_SAME_SITE_KIND_STRICT, +} COREWEBVIEW2_COOKIE_SAME_SITE_KIND; + +/// Kind of cross origin resource access allowed for host resources during download. +/// Note that other normal access checks like same origin DOM access check and [Content +/// Security Policy](https://developer.mozilla.org/docs/Web/HTTP/CSP) still apply. +/// The following table illustrates the host resource cross origin access according to +/// access context and `COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND`. +/// +/// Cross Origin Access Context | DENY | ALLOW | DENY_CORS +/// --- | --- | --- | --- +/// From DOM like src of img, script or iframe element| Deny | Allow | Allow +/// From Script like Fetch or XMLHttpRequest| Deny | Allow | Deny +[v1_enum] +typedef enum COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND { + /// All cross origin resource access is denied, including normal sub resource access + /// as src of a script or image element. + COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_DENY, + + /// All cross origin resource access is allowed, including accesses that are + /// subject to Cross-Origin Resource Sharing(CORS) check. The behavior is similar to + /// a web site sends back http header Access-Control-Allow-Origin: *. + COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_ALLOW, + + /// Cross origin resource access is allowed for normal sub resource access like + /// as src of a script or image element, while any access that subjects to CORS check + /// will be denied. + /// See [Cross-Origin Resource Sharing](https://developer.mozilla.org/docs/Web/HTTP/CORS) + /// for more information. + COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_DENY_CORS, +} COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND; + +/// Specifies the JavaScript dialog type used in the +/// `ICoreWebView2ScriptDialogOpeningEventHandler` interface. + +[v1_enum] +typedef enum COREWEBVIEW2_SCRIPT_DIALOG_KIND { + + /// Indicates that the dialog uses the `window.alert` JavaScript function. + + COREWEBVIEW2_SCRIPT_DIALOG_KIND_ALERT, + + /// Indicates that the dialog uses the `window.confirm` JavaScript function. + + COREWEBVIEW2_SCRIPT_DIALOG_KIND_CONFIRM, + + /// Indicates that the dialog uses the `window.prompt` JavaScript function. + + COREWEBVIEW2_SCRIPT_DIALOG_KIND_PROMPT, + + /// Indicates that the dialog uses the `beforeunload` JavaScript event. + + COREWEBVIEW2_SCRIPT_DIALOG_KIND_BEFOREUNLOAD, +} COREWEBVIEW2_SCRIPT_DIALOG_KIND; + +/// Specifies the process failure type used in the +/// `ICoreWebView2ProcessFailedEventArgs` interface. The values in this enum +/// make reference to the process kinds in the Chromium architecture. For more +/// information about what these processes are and what they do, see +/// [Browser Architecture - Inside look at modern web browser](https://developers.google.com/web/updates/2018/09/inside-browser-part1). + +[v1_enum] +typedef enum COREWEBVIEW2_PROCESS_FAILED_KIND { + + /// Indicates that the browser process ended unexpectedly. The WebView + /// automatically moves to the Closed state. The app has to recreate a new + /// WebView to recover from this failure. + + COREWEBVIEW2_PROCESS_FAILED_KIND_BROWSER_PROCESS_EXITED, + + /// Indicates that the main frame's render process ended unexpectedly. Any + /// subframes in the WebView will be gone too. A new render process is + /// created automatically and navigated to an error page. You can use the + /// `Reload` method to try to recover from this failure. Alternatively, you + /// can `Close` and recreate the WebView. + + COREWEBVIEW2_PROCESS_FAILED_KIND_RENDER_PROCESS_EXITED, + + /// Indicates that the main frame's render process is unresponsive. Renderer + /// process unresponsiveness can happen for the following reasons: + /// + /// * There is a **long-running script** being executed. For example, the + /// web content in your WebView might be performing a synchronous XHR, or have + /// entered an infinite loop. + /// * The **system is busy**. + /// + /// The `ProcessFailed` event will continue to be raised every few seconds + /// until the renderer process has become responsive again. The application + /// can consider taking action if the event keeps being raised. For example, + /// the application might show UI for the user to decide to keep waiting or + /// reload the page, or navigate away. + + COREWEBVIEW2_PROCESS_FAILED_KIND_RENDER_PROCESS_UNRESPONSIVE, + + /// Indicates that a frame-only render process ended unexpectedly. The process + /// exit does not affect the top-level document, only a subset of the + /// subframes within it. The content in these frames is replaced with an error + /// page in the frame. Your application can communicate with the main frame to + /// recover content in the impacted frames, using + /// `ICoreWebView2ProcessFailedEventArgs2::FrameInfosForFailedProcess` to get + /// information about the impacted frames. + + COREWEBVIEW2_PROCESS_FAILED_KIND_FRAME_RENDER_PROCESS_EXITED, + + /// Indicates that a utility process ended unexpectedly. The failed process + /// is recreated automatically. Your application does **not** need to handle + /// recovery for this event, but can use `ICoreWebView2ProcessFailedEventArgs` + /// and `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure, including `ProcessDescription`. + + COREWEBVIEW2_PROCESS_FAILED_KIND_UTILITY_PROCESS_EXITED, + + /// Indicates that a sandbox helper process ended unexpectedly. This failure + /// is not fatal. Your application does **not** need to handle recovery for + /// this event, but can use `ICoreWebView2ProcessFailedEventArgs` and + /// `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure. + + COREWEBVIEW2_PROCESS_FAILED_KIND_SANDBOX_HELPER_PROCESS_EXITED, + + /// Indicates that the GPU process ended unexpectedly. The failed process + /// is recreated automatically. Your application does **not** need to handle + /// recovery for this event, but can use `ICoreWebView2ProcessFailedEventArgs` + /// and `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure. + + COREWEBVIEW2_PROCESS_FAILED_KIND_GPU_PROCESS_EXITED, + + /// Indicates that a PPAPI plugin process ended unexpectedly. This failure + /// is not fatal. Your application does **not** need to handle recovery for + /// this event, but can use `ICoreWebView2ProcessFailedEventArgs` and + /// `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure, including `ProcessDescription`. + + COREWEBVIEW2_PROCESS_FAILED_KIND_PPAPI_PLUGIN_PROCESS_EXITED, + + /// Indicates that a PPAPI plugin broker process ended unexpectedly. This failure + /// is not fatal. Your application does **not** need to handle recovery for + /// this event, but can use `ICoreWebView2ProcessFailedEventArgs` and + /// `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure. + + COREWEBVIEW2_PROCESS_FAILED_KIND_PPAPI_BROKER_PROCESS_EXITED, + + /// Indicates that a process of unspecified kind ended unexpectedly. Your + /// application can use `ICoreWebView2ProcessFailedEventArgs` and + /// `ICoreWebView2ProcessFailedEventArgs2` to collect information about + /// the failure. + + COREWEBVIEW2_PROCESS_FAILED_KIND_UNKNOWN_PROCESS_EXITED, +} COREWEBVIEW2_PROCESS_FAILED_KIND; + +/// Specifies the process failure reason used in the +/// `ICoreWebView2ProcessFailedEventArgs` interface. For process failures where +/// a process has exited, it indicates the type of issue that produced the +/// process exit. + +[v1_enum] +typedef enum COREWEBVIEW2_PROCESS_FAILED_REASON { + + /// An unexpected process failure occurred. + COREWEBVIEW2_PROCESS_FAILED_REASON_UNEXPECTED, + + /// The process became unresponsive. + /// This only applies to the main frame's render process. + + COREWEBVIEW2_PROCESS_FAILED_REASON_UNRESPONSIVE, + + /// The process was terminated. For example, from Task Manager. + + COREWEBVIEW2_PROCESS_FAILED_REASON_TERMINATED, + + /// The process crashed. Most crashes will generate dumps in the location + /// indicated by `ICoreWebView2Environment11::get_FailureReportFolderPath`. + + COREWEBVIEW2_PROCESS_FAILED_REASON_CRASHED, + + /// The process failed to launch. + + COREWEBVIEW2_PROCESS_FAILED_REASON_LAUNCH_FAILED, + + /// The process terminated due to running out of memory. + + COREWEBVIEW2_PROCESS_FAILED_REASON_OUT_OF_MEMORY, + + /// The process exited because its corresponding profile was deleted. + COREWEBVIEW2_PROCESS_FAILED_REASON_PROFILE_DELETED, +} COREWEBVIEW2_PROCESS_FAILED_REASON; + +/// Indicates the type of a permission request. + +[v1_enum] +typedef enum COREWEBVIEW2_PERMISSION_KIND { + + /// Indicates an unknown permission. + + COREWEBVIEW2_PERMISSION_KIND_UNKNOWN_PERMISSION, + + /// Indicates permission to capture audio. + + COREWEBVIEW2_PERMISSION_KIND_MICROPHONE, + + /// Indicates permission to capture video. + + COREWEBVIEW2_PERMISSION_KIND_CAMERA, + + /// Indicates permission to access geolocation. + + COREWEBVIEW2_PERMISSION_KIND_GEOLOCATION, + + /// Indicates permission to send web notifications. Apps that would like to + /// show notifications should handle `PermissionRequested` events + /// and no browser permission prompt will be shown for notification requests. + /// Note that push notifications are currently unavailable in WebView2. + + COREWEBVIEW2_PERMISSION_KIND_NOTIFICATIONS, + + /// Indicates permission to access generic sensor. Generic Sensor covering + /// ambient-light-sensor, accelerometer, gyroscope, and magnetometer. + + COREWEBVIEW2_PERMISSION_KIND_OTHER_SENSORS, + + /// Indicates permission to read the system clipboard without a user gesture. + + COREWEBVIEW2_PERMISSION_KIND_CLIPBOARD_READ, + + /// Indicates permission to automatically download multiple files. Permission + /// is requested when multiple downloads are triggered in quick succession. + + COREWEBVIEW2_PERMISSION_KIND_MULTIPLE_AUTOMATIC_DOWNLOADS, + + /// Indicates permission to read and write to files or folders on the device. + /// Permission is requested when developers use the [File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) + /// to show the file or folder picker to the end user, and then request + /// "readwrite" permission for the user's selection. + + COREWEBVIEW2_PERMISSION_KIND_FILE_READ_WRITE, + + /// Indicates permission to play audio and video automatically on sites. This + /// permission affects the autoplay attribute and play method of the audio and + /// video HTML elements, and the start method of the Web Audio API. See the + /// [Autoplay guide for media and Web Audio APIs](https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide) for details. + + COREWEBVIEW2_PERMISSION_KIND_AUTOPLAY, + + /// Indicates permission to use fonts on the device. Permission is requested + /// when developers use the [Local Font Access API](https://wicg.github.io/local-font-access/) + /// to query the system fonts available for styling web content. + + COREWEBVIEW2_PERMISSION_KIND_LOCAL_FONTS, + + /// Indicates permission to send and receive system exclusive messages to/from MIDI + /// (Musical Instrument Digital Interface) devices. Permission is requested + /// when developers use the [Web MIDI API](https://developer.mozilla.org/en-US/docs/Web/API/Web_MIDI_API) + /// to request access to system exclusive MIDI messages. + COREWEBVIEW2_PERMISSION_KIND_MIDI_SYSTEM_EXCLUSIVE_MESSAGES, + + /// Indicates permission to open and place windows on the screen. Permission is + /// requested when developers use the [Multi-Screen Window Placement API](https://www.w3.org/TR/window-placement/) + /// to get screen details. + COREWEBVIEW2_PERMISSION_KIND_WINDOW_MANAGEMENT, +} COREWEBVIEW2_PERMISSION_KIND; + +/// Specifies the response to a permission request. + +[v1_enum] +typedef enum COREWEBVIEW2_PERMISSION_STATE { + + /// Specifies that the default browser behavior is used, which normally + /// prompt users for decision. + + COREWEBVIEW2_PERMISSION_STATE_DEFAULT, + + /// Specifies that the permission request is granted. + + COREWEBVIEW2_PERMISSION_STATE_ALLOW, + + /// Specifies that the permission request is denied. + + COREWEBVIEW2_PERMISSION_STATE_DENY, +} COREWEBVIEW2_PERMISSION_STATE; + +/// Indicates the error status values for web navigations. + +[v1_enum] +typedef enum COREWEBVIEW2_WEB_ERROR_STATUS { + + /// Indicates that an unknown error occurred. + + COREWEBVIEW2_WEB_ERROR_STATUS_UNKNOWN, + + /// Indicates that the SSL certificate common name does not match the web + /// address. + + COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_COMMON_NAME_IS_INCORRECT, + + /// Indicates that the SSL certificate has expired. + + COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_EXPIRED, + + /// Indicates that the SSL client certificate contains errors. + + COREWEBVIEW2_WEB_ERROR_STATUS_CLIENT_CERTIFICATE_CONTAINS_ERRORS, + + /// Indicates that the SSL certificate has been revoked. + + COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_REVOKED, + + /// Indicates that the SSL certificate is not valid. The certificate may not + /// match the public key pins for the host name, the certificate is signed + /// by an untrusted authority or using a weak sign algorithm, the certificate + /// claimed DNS names violate name constraints, the certificate contains a + /// weak key, the validity period of the certificate is too long, lack of + /// revocation information or revocation mechanism, non-unique host name, + /// lack of certificate transparency information, or the certificate is + /// chained to a + /// [legacy Symantec root](https://security.googleblog.com/2018/03/distrust-of-symantec-pki-immediate.html). + + COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_IS_INVALID, + + /// Indicates that the host is unreachable. + + COREWEBVIEW2_WEB_ERROR_STATUS_SERVER_UNREACHABLE, + + /// Indicates that the connection has timed out. + + COREWEBVIEW2_WEB_ERROR_STATUS_TIMEOUT, + + /// Indicates that the server returned an invalid or unrecognized response. + + COREWEBVIEW2_WEB_ERROR_STATUS_ERROR_HTTP_INVALID_SERVER_RESPONSE, + + /// Indicates that the connection was stopped. + + COREWEBVIEW2_WEB_ERROR_STATUS_CONNECTION_ABORTED, + + /// Indicates that the connection was reset. + + COREWEBVIEW2_WEB_ERROR_STATUS_CONNECTION_RESET, + + /// Indicates that the Internet connection has been lost. + + COREWEBVIEW2_WEB_ERROR_STATUS_DISCONNECTED, + + /// Indicates that a connection to the destination was not established. + + COREWEBVIEW2_WEB_ERROR_STATUS_CANNOT_CONNECT, + + /// Indicates that the provided host name was not able to be resolved. + + COREWEBVIEW2_WEB_ERROR_STATUS_HOST_NAME_NOT_RESOLVED, + + /// Indicates that the operation was canceled. This status code is also used + /// in the following cases: + /// - When the app cancels a navigation via NavigationStarting event. + /// - For original navigation if the app navigates the WebView2 in a rapid succession + /// away after the load for original navigation commenced, but before it completed. + + COREWEBVIEW2_WEB_ERROR_STATUS_OPERATION_CANCELED, + + /// Indicates that the request redirect failed. + + COREWEBVIEW2_WEB_ERROR_STATUS_REDIRECT_FAILED, + + /// Indicates that an unexpected error occurred. + + COREWEBVIEW2_WEB_ERROR_STATUS_UNEXPECTED_ERROR, + + /// Indicates that user is prompted with a login, waiting on user action. + /// Initial navigation to a login site will always return this even if app provides + /// credential using BasicAuthenticationRequested. + /// HTTP response status code in this case is 401. + /// See status code reference here: https://developer.mozilla.org/docs/Web/HTTP/Status. + + COREWEBVIEW2_WEB_ERROR_STATUS_VALID_AUTHENTICATION_CREDENTIALS_REQUIRED, + + /// Indicates that user lacks proper authentication credentials for a proxy server. + /// HTTP response status code in this case is 407. + /// See status code reference here: https://developer.mozilla.org/docs/Web/HTTP/Status. + + COREWEBVIEW2_WEB_ERROR_STATUS_VALID_PROXY_AUTHENTICATION_REQUIRED, +} COREWEBVIEW2_WEB_ERROR_STATUS; + +/// Specifies the web resource request contexts. + +[v1_enum] +typedef enum COREWEBVIEW2_WEB_RESOURCE_CONTEXT { + + /// Specifies all resources. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_ALL, + + /// Specifies a document resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_DOCUMENT, + + /// Specifies a CSS resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_STYLESHEET, + + /// Specifies an image resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_IMAGE, + + /// Specifies another media resource such as a video. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_MEDIA, + + /// Specifies a font resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_FONT, + + /// Specifies a script resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_SCRIPT, + + /// Specifies an XML HTTP request, Fetch and EventSource API communication. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_XML_HTTP_REQUEST, + + /// Specifies a Fetch API communication. + + // Note that this isn't working. Fetch API requests are fired as a part + // of COREWEBVIEW2_WEB_RESOURCE_CONTEXT_XML_HTTP_REQUEST. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_FETCH, + + /// Specifies a TextTrack resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_TEXT_TRACK, + + /// Specifies an EventSource API communication. + + // Note that this isn't working. EventSource API requests are fired as a part + // of COREWEBVIEW2_WEB_RESOURCE_CONTEXT_XML_HTTP_REQUEST. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_EVENT_SOURCE, + + /// Specifies a WebSocket API communication. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_WEBSOCKET, + + /// Specifies a Web App Manifest. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_MANIFEST, + + /// Specifies a Signed HTTP Exchange. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_SIGNED_EXCHANGE, + + /// Specifies a Ping request. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_PING, + + /// Specifies a CSP Violation Report. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_CSP_VIOLATION_REPORT, + + /// Specifies an other resource. + + COREWEBVIEW2_WEB_RESOURCE_CONTEXT_OTHER +} COREWEBVIEW2_WEB_RESOURCE_CONTEXT; + +/// Specifies the reason for moving focus. + +[v1_enum] +typedef enum COREWEBVIEW2_MOVE_FOCUS_REASON { + + /// Specifies that the code is setting focus into WebView. + + COREWEBVIEW2_MOVE_FOCUS_REASON_PROGRAMMATIC, + + /// Specifies that the focus is moving due to Tab traversal forward. + + COREWEBVIEW2_MOVE_FOCUS_REASON_NEXT, + + /// Specifies that the focus is moving due to Tab traversal backward. + + COREWEBVIEW2_MOVE_FOCUS_REASON_PREVIOUS, +} COREWEBVIEW2_MOVE_FOCUS_REASON; + +/// Specifies the key event type that triggered an `AcceleratorKeyPressed` +/// event. + +[v1_enum] +typedef enum COREWEBVIEW2_KEY_EVENT_KIND { + + /// Specifies that the key event type corresponds to window message + /// `WM_KEYDOWN`. + + COREWEBVIEW2_KEY_EVENT_KIND_KEY_DOWN, + + /// Specifies that the key event type corresponds to window message + /// `WM_KEYUP`. + + COREWEBVIEW2_KEY_EVENT_KIND_KEY_UP, + + /// Specifies that the key event type corresponds to window message + /// `WM_SYSKEYDOWN`. + + COREWEBVIEW2_KEY_EVENT_KIND_SYSTEM_KEY_DOWN, + + /// Specifies that the key event type corresponds to window message + /// `WM_SYSKEYUP`. + + COREWEBVIEW2_KEY_EVENT_KIND_SYSTEM_KEY_UP, +} COREWEBVIEW2_KEY_EVENT_KIND; + +/// Specifies the browser process exit type used in the +/// `ICoreWebView2BrowserProcessExitedEventArgs` interface. + +[v1_enum] +typedef enum COREWEBVIEW2_BROWSER_PROCESS_EXIT_KIND { + + /// Indicates that the browser process ended normally. + + COREWEBVIEW2_BROWSER_PROCESS_EXIT_KIND_NORMAL, + + /// Indicates that the browser process ended unexpectedly. + /// A `ProcessFailed` event will also be sent to listening WebViews from the + /// `ICoreWebView2Environment` associated to the failed process. + + COREWEBVIEW2_BROWSER_PROCESS_EXIT_KIND_FAILED +} COREWEBVIEW2_BROWSER_PROCESS_EXIT_KIND; + +/// Contains the information packed into the `LPARAM` sent to a Win32 key +/// event. For more information about `WM_KEYDOWN`, navigate to +/// [WM_KEYDOWN message](/windows/win32/inputdev/wm-keydown). + +typedef struct COREWEBVIEW2_PHYSICAL_KEY_STATUS { + + /// Specifies the repeat count for the current message. + + UINT32 RepeatCount; + + /// Specifies the scan code. + + UINT32 ScanCode; + + /// Indicates that the key is an extended key. + + BOOL IsExtendedKey; + + /// Indicates that a menu key is held down (context code). + + BOOL IsMenuKeyDown; + + /// Indicates that the key was held down. + + BOOL WasKeyDown; + + /// Indicates that the key was released. + + BOOL IsKeyReleased; +} COREWEBVIEW2_PHYSICAL_KEY_STATUS; + +/// A value representing RGBA color (Red, Green, Blue, Alpha) for WebView2. +/// Each component takes a value from 0 to 255, with 0 being no intensity +/// and 255 being the highest intensity. + +typedef struct COREWEBVIEW2_COLOR { + + /// Specifies the intensity of the Alpha ie. opacity value. 0 is transparent, + /// 255 is opaque. + + BYTE A; + + /// Specifies the intensity of the Red color. + + BYTE R; + + /// Specifies the intensity of the Green color. + + BYTE G; + + /// Specifies the intensity of the Blue color. + + BYTE B; +} COREWEBVIEW2_COLOR; + +/// Mouse event type used by SendMouseInput to convey the type of mouse event +/// being sent to WebView. The values of this enum align with the matching +/// WM_* window messages. + +[v1_enum] +typedef enum COREWEBVIEW2_MOUSE_EVENT_KIND { + + /// Mouse horizontal wheel scroll event, WM_MOUSEHWHEEL. + + COREWEBVIEW2_MOUSE_EVENT_KIND_HORIZONTAL_WHEEL = 0x020E, + + /// Left button double click mouse event, WM_LBUTTONDBLCLK. + + COREWEBVIEW2_MOUSE_EVENT_KIND_LEFT_BUTTON_DOUBLE_CLICK = 0x0203, + + /// Left button down mouse event, WM_LBUTTONDOWN. + + COREWEBVIEW2_MOUSE_EVENT_KIND_LEFT_BUTTON_DOWN = 0x0201, + + /// Left button up mouse event, WM_LBUTTONUP. + + COREWEBVIEW2_MOUSE_EVENT_KIND_LEFT_BUTTON_UP = 0x0202, + + /// Mouse leave event, WM_MOUSELEAVE. + + COREWEBVIEW2_MOUSE_EVENT_KIND_LEAVE = 0x02A3, + + /// Middle button double click mouse event, WM_MBUTTONDBLCLK. + + COREWEBVIEW2_MOUSE_EVENT_KIND_MIDDLE_BUTTON_DOUBLE_CLICK = 0x0209, + + /// Middle button down mouse event, WM_MBUTTONDOWN. + + COREWEBVIEW2_MOUSE_EVENT_KIND_MIDDLE_BUTTON_DOWN = 0x0207, + + /// Middle button up mouse event, WM_MBUTTONUP. + + COREWEBVIEW2_MOUSE_EVENT_KIND_MIDDLE_BUTTON_UP = 0x0208, + + /// Mouse move event, WM_MOUSEMOVE. + + COREWEBVIEW2_MOUSE_EVENT_KIND_MOVE = 0x0200, + + /// Right button double click mouse event, WM_RBUTTONDBLCLK. + + COREWEBVIEW2_MOUSE_EVENT_KIND_RIGHT_BUTTON_DOUBLE_CLICK = 0x0206, + + /// Right button down mouse event, WM_RBUTTONDOWN. + + COREWEBVIEW2_MOUSE_EVENT_KIND_RIGHT_BUTTON_DOWN = 0x0204, + + /// Right button up mouse event, WM_RBUTTONUP. + + COREWEBVIEW2_MOUSE_EVENT_KIND_RIGHT_BUTTON_UP = 0x0205, + + /// Mouse wheel scroll event, WM_MOUSEWHEEL. + + COREWEBVIEW2_MOUSE_EVENT_KIND_WHEEL = 0x020A, + + /// First or second X button double click mouse event, WM_XBUTTONDBLCLK. + + COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_DOUBLE_CLICK = 0x020D, + + /// First or second X button down mouse event, WM_XBUTTONDOWN. + + COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_DOWN = 0x020B, + + /// First or second X button up mouse event, WM_XBUTTONUP. + + COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_UP = 0x020C, + + /// Mouse Right Button Down event over a nonclient area, WM_NCRBUTTONDOWN. + + COREWEBVIEW2_MOUSE_EVENT_KIND_NON_CLIENT_RIGHT_BUTTON_DOWN = 0x00A4, + + /// Mouse Right Button up event over a nonclient area, WM_NCRBUTTONUP. + + COREWEBVIEW2_MOUSE_EVENT_KIND_NON_CLIENT_RIGHT_BUTTON_UP = 0x00A5, +} COREWEBVIEW2_MOUSE_EVENT_KIND; + +/// Mouse event virtual keys associated with a COREWEBVIEW2_MOUSE_EVENT_KIND for +/// SendMouseInput. These values can be combined into a bit flag if more than +/// one virtual key is pressed for the event. The values of this enum align +/// with the matching MK_* mouse keys. + +[v1_enum] +typedef enum COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS { + + /// No additional keys pressed. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_NONE = 0x0, + + /// Left mouse button is down, MK_LBUTTON. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_LEFT_BUTTON = 0x0001, + + /// Right mouse button is down, MK_RBUTTON. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_RIGHT_BUTTON = 0x0002, + + /// SHIFT key is down, MK_SHIFT. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_SHIFT = 0x0004, + + /// CTRL key is down, MK_CONTROL. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_CONTROL = 0x0008, + + /// Middle mouse button is down, MK_MBUTTON. + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_MIDDLE_BUTTON = 0x0010, + + /// First X button is down, MK_XBUTTON1 + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_X_BUTTON1 = 0x0020, + + /// Second X button is down, MK_XBUTTON2 + + COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS_X_BUTTON2 = 0x0040, +} COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS; +cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS)") + +/// Pointer event type used by SendPointerInput to convey the type of pointer +/// event being sent to WebView. The values of this enum align with the +/// matching WM_POINTER* window messages. + +[v1_enum] +typedef enum COREWEBVIEW2_POINTER_EVENT_KIND { + + /// Corresponds to WM_POINTERACTIVATE. + + COREWEBVIEW2_POINTER_EVENT_KIND_ACTIVATE = 0x024B, + + /// Corresponds to WM_POINTERDOWN. + + COREWEBVIEW2_POINTER_EVENT_KIND_DOWN = 0x0246, + + /// Corresponds to WM_POINTERENTER. + + COREWEBVIEW2_POINTER_EVENT_KIND_ENTER = 0x0249, + + /// Corresponds to WM_POINTERLEAVE. + + COREWEBVIEW2_POINTER_EVENT_KIND_LEAVE = 0x024A, + + /// Corresponds to WM_POINTERUP. + + COREWEBVIEW2_POINTER_EVENT_KIND_UP = 0x0247, + + /// Corresponds to WM_POINTERUPDATE. + + COREWEBVIEW2_POINTER_EVENT_KIND_UPDATE = 0x0245, +} COREWEBVIEW2_POINTER_EVENT_KIND; + +/// Mode for how the Bounds property is interpreted in relation to the RasterizationScale property. +[v1_enum] +typedef enum COREWEBVIEW2_BOUNDS_MODE { + + /// Bounds property represents raw pixels. Physical size of Webview is not impacted by RasterizationScale. + + COREWEBVIEW2_BOUNDS_MODE_USE_RAW_PIXELS, + + /// Bounds property represents logical pixels and the RasterizationScale property is used to get the physical size of the WebView. + + COREWEBVIEW2_BOUNDS_MODE_USE_RASTERIZATION_SCALE, +} COREWEBVIEW2_BOUNDS_MODE; + +/// Specifies the client certificate kind. +[v1_enum] typedef enum COREWEBVIEW2_CLIENT_CERTIFICATE_KIND { + /// Specifies smart card certificate. + COREWEBVIEW2_CLIENT_CERTIFICATE_KIND_SMART_CARD, + /// Specifies PIN certificate. + COREWEBVIEW2_CLIENT_CERTIFICATE_KIND_PIN, + /// Specifies other certificate. + COREWEBVIEW2_CLIENT_CERTIFICATE_KIND_OTHER, +} COREWEBVIEW2_CLIENT_CERTIFICATE_KIND; + +/// State of the download operation. +[v1_enum] +typedef enum COREWEBVIEW2_DOWNLOAD_STATE { + /// The download is in progress. + COREWEBVIEW2_DOWNLOAD_STATE_IN_PROGRESS, + /// The connection with the file host was broken. The `InterruptReason` property + /// can be accessed from `ICoreWebView2DownloadOperation`. See + /// `COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON` for descriptions of kinds of + /// interrupt reasons. Host can check whether an interrupted download can be + /// resumed with the `CanResume` property on the `ICoreWebView2DownloadOperation`. + /// Once resumed, a download is in the `COREWEBVIEW2_DOWNLOAD_STATE_IN_PROGRESS` state. + COREWEBVIEW2_DOWNLOAD_STATE_INTERRUPTED, + /// The download completed successfully. + COREWEBVIEW2_DOWNLOAD_STATE_COMPLETED, +} COREWEBVIEW2_DOWNLOAD_STATE; + +/// Reason why a download was interrupted. +[v1_enum] +typedef enum COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON { + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NONE, + + /// Generic file error. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_FAILED, + /// Access denied due to security restrictions. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_ACCESS_DENIED, + /// Disk full. User should free some space or choose a different location to + /// store the file. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_NO_SPACE, + /// Result file path with file name is too long. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_NAME_TOO_LONG, + /// File is too large for file system. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_TOO_LARGE, + /// Microsoft Defender Smartscreen detected a virus in the file. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_MALICIOUS, + /// File was in use, too many files opened, or out of memory. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_TRANSIENT_ERROR, + /// File blocked by local policy. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_BLOCKED_BY_POLICY, + /// Security check failed unexpectedly. Microsoft Defender SmartScreen could + /// not scan this file. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_SECURITY_CHECK_FAILED, + /// Seeking past the end of a file in opening a file, as part of resuming an + /// interrupted download. The file did not exist or was not as large as + /// expected. Partially downloaded file was truncated or deleted, and download + /// will be restarted automatically. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_TOO_SHORT, + /// Partial file did not match the expected hash and was deleted. Download + /// will be restarted automatically. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_HASH_MISMATCH, + + /// Generic network error. User can retry the download manually. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NETWORK_FAILED, + /// Network operation timed out. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NETWORK_TIMEOUT, + /// Network connection lost. User can retry the download manually. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NETWORK_DISCONNECTED, + /// Server has gone down. User can retry the download manually. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NETWORK_SERVER_DOWN, + /// Network request invalid because original or redirected URI is invalid, has + /// an unsupported scheme, or is disallowed by network policy. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_NETWORK_INVALID_REQUEST, + + /// Generic server error. User can retry the download manually. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_FAILED, + /// Server does not support range requests. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_NO_RANGE, + /// Server does not have the requested data. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_BAD_CONTENT, + /// Server did not authorize access to resource. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_UNAUTHORIZED, + /// Server certificate problem. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_CERTIFICATE_PROBLEM, + /// Server access forbidden. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_FORBIDDEN, + /// Unexpected server response. Responding server may not be intended server. + /// User can retry the download manually. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_UNEXPECTED_RESPONSE, + /// Server sent fewer bytes than the Content-Length header. Content-length + /// header may be invalid or connection may have closed. Download is treated + /// as complete unless there are + /// [strong validators](https://tools.ietf.org/html/rfc7232#section-2) present + /// to interrupt the download. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_CONTENT_LENGTH_MISMATCH, + /// Unexpected cross-origin redirect. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_CROSS_ORIGIN_REDIRECT, + + /// User canceled the download. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_USER_CANCELED, + /// User shut down the WebView. Resuming downloads that were interrupted + /// during shutdown is not yet supported. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_USER_SHUTDOWN, + /// User paused the download. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_USER_PAUSED, + + /// WebView crashed. + COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_DOWNLOAD_PROCESS_CRASHED, +} COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON; + +/// The orientation for printing, used by the `Orientation` property on +/// `ICoreWebView2PrintSettings`. +[v1_enum] +typedef enum COREWEBVIEW2_PRINT_ORIENTATION { + /// Print the page(s) in portrait orientation. + COREWEBVIEW2_PRINT_ORIENTATION_PORTRAIT, + + /// Print the page(s) in landscape orientation. + COREWEBVIEW2_PRINT_ORIENTATION_LANDSCAPE, +} COREWEBVIEW2_PRINT_ORIENTATION; + +/// The default download dialog can be aligned to any of the WebView corners +/// by setting the `DefaultDownloadDialogCornerAlignment` property. The default +/// position is top-right corner. +[v1_enum] +typedef enum COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT { + + /// Top-left corner of the WebView. + COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT_TOP_LEFT, + + /// Top-right corner of the WebView. + COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT_TOP_RIGHT, + + /// Bottom-left corner of the WebView. + COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT_BOTTOM_LEFT, + + /// Bottom-right corner of the WebView. + COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT_BOTTOM_RIGHT, + +} COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT; + +/// Indicates the process type used in the ICoreWebView2ProcessInfo interface. +[v1_enum] +typedef enum COREWEBVIEW2_PROCESS_KIND { + /// Indicates the browser process kind. + COREWEBVIEW2_PROCESS_KIND_BROWSER, + + /// Indicates the render process kind. + COREWEBVIEW2_PROCESS_KIND_RENDERER, + + /// Indicates the utility process kind. + COREWEBVIEW2_PROCESS_KIND_UTILITY, + + /// Indicates the sandbox helper process kind. + COREWEBVIEW2_PROCESS_KIND_SANDBOX_HELPER, + + /// Indicates the GPU process kind. + COREWEBVIEW2_PROCESS_KIND_GPU, + + /// Indicates the PPAPI plugin process kind. + COREWEBVIEW2_PROCESS_KIND_PPAPI_PLUGIN, + + /// Indicates the PPAPI plugin broker process kind. + COREWEBVIEW2_PROCESS_KIND_PPAPI_BROKER, +} COREWEBVIEW2_PROCESS_KIND; + +// PDF toolbar item. This enum must be in sync with ToolBarItem in pdf-store-data-types.ts +/// Specifies the PDF toolbar item types used for the `ICoreWebView2Settings::put_HiddenPdfToolbarItems` method. +[v1_enum] +typedef enum COREWEBVIEW2_PDF_TOOLBAR_ITEMS { + + /// No item + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_NONE = 0x0, + + /// The save button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_SAVE = 0x0001, + + /// The print button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_PRINT = 0x0002, + + /// The save as button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_SAVE_AS = 0x0004, + + /// The zoom in button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_ZOOM_IN = 0x0008, + + /// The zoom out button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_ZOOM_OUT = 0x0010, + + /// The rotate button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_ROTATE = 0x0020, + + /// The fit page button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_FIT_PAGE = 0x0040, + + /// The page layout button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_PAGE_LAYOUT = 0x0080, + + /// The bookmarks button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_BOOKMARKS = 0x0100, + + /// The page select button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_PAGE_SELECTOR = 0x0200, + + /// The search button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_SEARCH = 0x0400, + + /// The full screen button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_FULL_SCREEN = 0x0800, + + /// The more settings button + COREWEBVIEW2_PDF_TOOLBAR_ITEMS_MORE_SETTINGS = 0x1000, + +} COREWEBVIEW2_PDF_TOOLBAR_ITEMS; +cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(COREWEBVIEW2_PDF_TOOLBAR_ITEMS)") + +/// Indicates the kind of context for which the context menu was created +/// for the `ICoreWebView2ContextMenuTarget::get_Kind` method. +/// This enum will always represent the active element that caused the context menu request. +/// If there is a selection with multiple images, audio and text, for example, the element that +/// the end user right clicks on within this selection will be the option represented by this enum. +[v1_enum] +typedef enum COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND { + /// Indicates that the context menu was created for the page without any additional content. + COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND_PAGE, + + /// Indicates that the context menu was created for an image element. + COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND_IMAGE, + + /// Indicates that the context menu was created for selected text. + COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND_SELECTED_TEXT, + + /// Indicates that the context menu was created for an audio element. + COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND_AUDIO, + + /// Indicates that the context menu was created for a video element. + COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND_VIDEO, +} COREWEBVIEW2_CONTEXT_MENU_TARGET_KIND; + +/// Specifies the menu item kind +/// for the `ICoreWebView2ContextMenuItem::get_Kind` method +[v1_enum] +typedef enum COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND { + /// Specifies a command menu item kind. + COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND_COMMAND, + + /// Specifies a check box menu item kind. `ContextMenuItem` objects of this kind + /// will need the `IsChecked` property to determine current state of the check box. + COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND_CHECK_BOX, + + /// Specifies a radio button menu item kind. `ContextMenuItem` objects of this kind + /// will need the `IsChecked` property to determine current state of the radio button. + COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND_RADIO, + + /// Specifies a separator menu item kind. `ContextMenuItem` objects of this kind + /// are used to signal a visual separator with no functionality. + COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND_SEPARATOR, + + /// Specifies a submenu menu item kind. `ContextMenuItem` objects of this kind will contain + /// a `ContextMenuItemCollection` of its children `ContextMenuItem` objects. + COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND_SUBMENU, +} COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND; + +/// An enum to represent the options for WebView2 color scheme: auto, light, or dark. +[v1_enum] +typedef enum COREWEBVIEW2_PREFERRED_COLOR_SCHEME { + /// Auto color scheme. + COREWEBVIEW2_PREFERRED_COLOR_SCHEME_AUTO, + + /// Light color scheme. + COREWEBVIEW2_PREFERRED_COLOR_SCHEME_LIGHT, + + /// Dark color scheme. + COREWEBVIEW2_PREFERRED_COLOR_SCHEME_DARK +} COREWEBVIEW2_PREFERRED_COLOR_SCHEME; + +/// Specifies the datatype for the +/// `ICoreWebView2Profile2::ClearBrowsingData` method. +[v1_enum] +typedef enum COREWEBVIEW2_BROWSING_DATA_KINDS { + + /// Specifies file systems data. + COREWEBVIEW2_BROWSING_DATA_KINDS_FILE_SYSTEMS = 1 << 0, + + /// Specifies data stored by the IndexedDB DOM feature. + COREWEBVIEW2_BROWSING_DATA_KINDS_INDEXED_DB = 1 << 1, + + /// Specifies data stored by the localStorage DOM API. + COREWEBVIEW2_BROWSING_DATA_KINDS_LOCAL_STORAGE = 1 << 2, + + /// Specifies data stored by the Web SQL database DOM API. + COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL = 1 << 3, + + /// Specifies data stored by the CacheStorage DOM API. + COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE = 1 << 4, + + /// Specifies DOM storage data, now and future. This browsing data kind is + /// inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_FILE_SYSTEMS, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_INDEXED_DB, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_LOCAL_STORAGE, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_SERVICE_WORKERS, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE, + /// and some other data kinds not listed yet to keep consistent with + /// [DOM-accessible storage](https://www.w3.org/TR/clear-site-data/#storage). + COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_DOM_STORAGE = 1 << 5, + + /// Specifies HTTP cookies data. + COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES = 1 << 6, + + /// Specifies all site data, now and future. This browsing data kind + /// is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_DOM_STORAGE and + /// COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES. New site data types + /// may be added to this data kind in the future. + COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_SITE = 1 << 7, + + /// Specifies disk cache. + COREWEBVIEW2_BROWSING_DATA_KINDS_DISK_CACHE = 1 << 8, + + /// Specifies download history data. + COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY = 1 << 9, + + /// Specifies general autofill form data. + /// This excludes password information and includes information like: + /// names, street and email addresses, phone numbers, and arbitrary input. + /// This also includes payment data. + COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL = 1 << 10, + + /// Specifies password autosave data. + COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE = 1 << 11, + + /// Specifies browsing history data. + COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY = 1 << 12, + + /// Specifies settings data. + COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS = 1 << 13, + + /// Specifies profile data that should be wiped to make it look like a new profile. + /// This does not delete account-scoped data like passwords but will remove access + /// to account-scoped data by signing the user out. + /// Specifies all profile data, now and future. New profile data types may be added + /// to this data kind in the future. + /// This browsing data kind is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_SITE, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_DISK_CACHE, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE, + /// COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY, and + /// COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS. + COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_PROFILE = 1 << 14, + + /// Specifies service workers registered for an origin, and clear will result in + /// termination and deregistration of them. + COREWEBVIEW2_BROWSING_DATA_KINDS_SERVICE_WORKERS = 1 << 15, +} COREWEBVIEW2_BROWSING_DATA_KINDS; +cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(COREWEBVIEW2_BROWSING_DATA_KINDS)") + +/// Specifies the action type when server certificate error is detected to be +/// used in the `ICoreWebView2ServerCertificateErrorDetectedEventArgs` +/// interface. +[v1_enum] typedef enum COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION { + /// Indicates to ignore the warning and continue the request with the TLS + /// certificate. This decision is cached for the RequestUri's host and the + /// server certificate in the session. + COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION_ALWAYS_ALLOW, + + /// Indicates to reject the certificate and cancel the request. + COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION_CANCEL, + + /// Indicates to display the default TLS interstitial error page to user for + /// page navigations. + /// For others TLS certificate is rejected and the request is cancelled. + COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION_DEFAULT +} COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION; + +/// Specifies the image format to use for favicon. +[v1_enum] +typedef enum COREWEBVIEW2_FAVICON_IMAGE_FORMAT { + /// Indicates that the PNG image format is used. + COREWEBVIEW2_FAVICON_IMAGE_FORMAT_PNG, + + /// Indicates the JPEG image format is used. + COREWEBVIEW2_FAVICON_IMAGE_FORMAT_JPEG, +} COREWEBVIEW2_FAVICON_IMAGE_FORMAT; + +/// Specifies the print dialog kind. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_DIALOG_KIND { + /// Opens the browser print preview dialog. + COREWEBVIEW2_PRINT_DIALOG_KIND_BROWSER, + + /// Opens the system print dialog. + COREWEBVIEW2_PRINT_DIALOG_KIND_SYSTEM, + +} COREWEBVIEW2_PRINT_DIALOG_KIND; + +/// Specifies the duplex option for a print. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_DUPLEX { + /// The default duplex for a printer. + COREWEBVIEW2_PRINT_DUPLEX_DEFAULT, + + /// Print on only one side of the sheet. + COREWEBVIEW2_PRINT_DUPLEX_ONE_SIDED, + + /// Print on both sides of the sheet, flipped along the long edge. + COREWEBVIEW2_PRINT_DUPLEX_TWO_SIDED_LONG_EDGE, + + /// Print on both sides of the sheet, flipped along the short edge. + COREWEBVIEW2_PRINT_DUPLEX_TWO_SIDED_SHORT_EDGE, + +} COREWEBVIEW2_PRINT_DUPLEX; + +/// Specifies the color mode for a print. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_COLOR_MODE { + /// The default color mode for a printer. + COREWEBVIEW2_PRINT_COLOR_MODE_DEFAULT, + + /// Indicate that the printed output will be in color. + COREWEBVIEW2_PRINT_COLOR_MODE_COLOR, + + /// Indicate that the printed output will be in shades of gray. + COREWEBVIEW2_PRINT_COLOR_MODE_GRAYSCALE, + +} COREWEBVIEW2_PRINT_COLOR_MODE; + +/// Specifies the collation for a print. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_COLLATION { + /// The default collation for a printer. + COREWEBVIEW2_PRINT_COLLATION_DEFAULT, + + /// Indicate that the collation has been selected for the printed output. + COREWEBVIEW2_PRINT_COLLATION_COLLATED, + + /// Indicate that the collation has not been selected for the printed output. + COREWEBVIEW2_PRINT_COLLATION_UNCOLLATED, + +} COREWEBVIEW2_PRINT_COLLATION; + +/// Specifies the media size for a print. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_MEDIA_SIZE { + /// The default media size for a printer. + COREWEBVIEW2_PRINT_MEDIA_SIZE_DEFAULT, + + /// Indicate custom media size that is specific to the printer. + COREWEBVIEW2_PRINT_MEDIA_SIZE_CUSTOM, + +} COREWEBVIEW2_PRINT_MEDIA_SIZE; + +/// Indicates the status for printing. +[v1_enum] typedef enum COREWEBVIEW2_PRINT_STATUS { + /// Indicates that the print operation is succeeded. + COREWEBVIEW2_PRINT_STATUS_SUCCEEDED, + + /// Indicates that the printer is not available. + COREWEBVIEW2_PRINT_STATUS_PRINTER_UNAVAILABLE, + + /// Indicates that the print operation is failed. + COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR, + +} COREWEBVIEW2_PRINT_STATUS; + +/// Tracking prevention levels. +[v1_enum] typedef enum COREWEBVIEW2_TRACKING_PREVENTION_LEVEL { + /// Tracking prevention is turned off. + COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_NONE, + /// The least restrictive level of tracking prevention. Set to this level to + /// protect against malicious trackers but allows most other trackers and + /// personalize content and ads. + /// + /// See [Current tracking prevention + /// behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior) + /// for fine-grained information on what is being blocked with this level and + /// can change with different Edge versions. + COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_BASIC, + /// The default level of tracking prevention. Set to this level to + /// protect against social media tracking on top of malicious trackers. + /// Content and ads will likely be less personalized. + /// + /// See [Current tracking prevention + /// behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior) + /// for fine-grained information on what is being blocked with this level and + /// can change with different Edge versions. + COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_BALANCED, + /// The most restrictive level of tracking prevention. Set to this level to + /// protect + /// against malicious trackers and most trackers across sites. Content and ads + /// will likely have minimal personalization. + /// + /// This level blocks the most trackers but could cause some websites to not + /// behave as expected. + /// + /// See [Current tracking prevention + /// behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior) + /// for fine-grained information on what is being blocked with this level and + /// can change with different Edge versions. + COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_STRICT, +} COREWEBVIEW2_TRACKING_PREVENTION_LEVEL; + +/// Specifies the desired access from script to `CoreWebView2SharedBuffer`. +[v1_enum] +typedef enum COREWEBVIEW2_SHARED_BUFFER_ACCESS { + /// Script from web page only has read access to the shared buffer. + COREWEBVIEW2_SHARED_BUFFER_ACCESS_READ_ONLY, + + /// Script from web page has read and write access to the shared buffer. + COREWEBVIEW2_SHARED_BUFFER_ACCESS_READ_WRITE + +} COREWEBVIEW2_SHARED_BUFFER_ACCESS ; + +/// Specifies memory usage target level of WebView. +[v1_enum] +typedef enum COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL { + /// Specifies normal memory usage target level. + COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_NORMAL, + + /// Specifies low memory usage target level. + /// Used for inactivate WebView for reduced memory consumption. + COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_LOW, + +} COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL; + +/// Specifies the navigation kind of each navigation. +[v1_enum] +typedef enum COREWEBVIEW2_NAVIGATION_KIND { + /// A navigation caused by `CoreWebView2.Reload()`, `location.reload()`, the end user + /// using F5 or other UX, or other reload mechanisms to reload the current document + /// without modifying the navigation history. + COREWEBVIEW2_NAVIGATION_KIND_RELOAD = 0, + + /// A navigation back or forward to a different entry in the session navigation history, + /// like via `CoreWebView2.Back()`, `location.back()`, the end user pressing Alt+Left + /// or other UX, or other mechanisms to navigate back or forward in the current + /// session navigation history. + /// + // Note: This kind doesn't distinguish back or forward, because we can't + // distinguish it from origin source `blink.mojom.NavigationType`. + COREWEBVIEW2_NAVIGATION_KIND_BACK_OR_FORWARD = 1, + + /// A navigation to another document, which can be caused by `CoreWebView2.Navigate()`, + /// `window.location.href = ...`, or other WebView2 or DOM APIs that navigate to a new URI. + COREWEBVIEW2_NAVIGATION_KIND_NEW_DOCUMENT = 2, + +} COREWEBVIEW2_NAVIGATION_KIND; + +// End of enums and structs + +/// WebView2 enables you to host web content using the latest Microsoft Edge +/// browser and web technology. + +[uuid(76eceacb-0462-4d94-ac83-423a6793775e), object, pointer_default(unique)] +interface ICoreWebView2 : IUnknown { + + /// The `ICoreWebView2Settings` object contains various modifiable settings + /// for the running WebView. + + [propget] HRESULT Settings([out, retval] ICoreWebView2Settings** settings); + + /// The URI of the current top level document. This value potentially + /// changes as a part of the `SourceChanged` event that runs for some cases + /// such as navigating to a different site or fragment navigations. It + /// remains the same for other types of navigations such as page refreshes + /// or `history.pushState` with the same URL as the current page. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + /// + /// \snippet ControlComponent.cpp SourceChanged + [propget] HRESULT Source([out, retval] LPWSTR* uri); + + /// Cause a navigation of the top-level document to run to the specified URI. + /// For more information, navigate to [Navigation + /// events](/microsoft-edge/webview2/concepts/navigation-events). + /// + /// \> [!NOTE]\n\> This operation starts a navigation and the corresponding + /// `NavigationStarting` event triggers sometime after `Navigate` runs. + /// + /// \snippet ControlComponent.cpp Navigate + HRESULT Navigate([in] LPCWSTR uri); + + /// Initiates a navigation to htmlContent as source HTML of a new document. + /// The `htmlContent` parameter may not be larger than 2 MB (2 * 1024 * 1024 bytes) in total size. + /// The origin of the new page is `about:blank`. + /// + /// ```cpp + /// SetVirtualHostNameToFolderMapping( + /// L"appassets.example", L"assets", + /// COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_DENY); + /// + /// WCHAR c_navString[] = LR" + /// + /// + /// + ///

Click me

+ /// "; + /// m_webView->NavigateToString(c_navString); + /// ``` + /// \snippet SettingsComponent.cpp NavigateToString + HRESULT NavigateToString([in] LPCWSTR htmlContent); + + /// Add an event handler for the `NavigationStarting` event. + /// `NavigationStarting` runs when the WebView main frame is requesting + /// permission to navigate to a different URI. Redirects trigger this + /// operation as well, and the navigation id is the same as the original + /// one. + /// + /// Navigations will be blocked until all `NavigationStarting` event handlers + /// return. + /// + /// \snippet SettingsComponent.cpp NavigationStarting + HRESULT add_NavigationStarting( + [in] ICoreWebView2NavigationStartingEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NavigationStarting`. + HRESULT remove_NavigationStarting( + [in] EventRegistrationToken token); + + /// Add an event handler for the `ContentLoading` event. `ContentLoading` + /// triggers before any content is loaded, including scripts added with + /// `AddScriptToExecuteOnDocumentCreated`. `ContentLoading` does not trigger + /// if a same page navigation occurs (such as through `fragment` + /// navigations or `history.pushState` navigations). This operation + /// follows the `NavigationStarting` and `SourceChanged` events and precedes + /// the `HistoryChanged` and `NavigationCompleted` events. + HRESULT add_ContentLoading( + [in] ICoreWebView2ContentLoadingEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ContentLoading`. + HRESULT remove_ContentLoading( + [in] EventRegistrationToken token); + + /// Add an event handler for the `SourceChanged` event. `SourceChanged` + /// triggers when the `Source` property changes. `SourceChanged` runs when + /// navigating to a different site or fragment navigations. It does not + /// trigger for other types of navigations such as page refreshes or + /// `history.pushState` with the same URL as the current page. + /// `SourceChanged` runs before `ContentLoading` for navigation to a new + /// document. + /// + /// \snippet ControlComponent.cpp SourceChanged + HRESULT add_SourceChanged( + [in] ICoreWebView2SourceChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_SourceChanged`. + HRESULT remove_SourceChanged( + [in] EventRegistrationToken token); + + /// Add an event handler for the `HistoryChanged` event. `HistoryChanged` is + /// raised for changes to joint session history, which consists of top-level + /// and manual frame navigations. Use `HistoryChanged` to verify that the + /// `CanGoBack` or `CanGoForward` value has changed. `HistoryChanged` also + /// runs for using `GoBack` or `GoForward`. `HistoryChanged` runs after + /// `SourceChanged` and `ContentLoading`. `CanGoBack` is false for + /// navigations initiated through ICoreWebView2Frame APIs if there has not yet + /// been a user gesture. + /// + /// \snippet ControlComponent.cpp HistoryChanged + HRESULT add_HistoryChanged( + [in] ICoreWebView2HistoryChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_HistoryChanged`. + HRESULT remove_HistoryChanged( + [in] EventRegistrationToken token); + + /// Add an event handler for the `NavigationCompleted` event. + /// `NavigationCompleted` runs when the WebView has completely loaded + /// (concurrently when `body.onload` runs) or loading stopped with error. + /// + /// \snippet ControlComponent.cpp NavigationCompleted + HRESULT add_NavigationCompleted( + [in] ICoreWebView2NavigationCompletedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NavigationCompleted`. + HRESULT remove_NavigationCompleted( + [in] EventRegistrationToken token); + + /// Add an event handler for the `FrameNavigationStarting` event. + /// `FrameNavigationStarting` triggers when a child frame in the WebView + /// requests permission to navigate to a different URI. Redirects trigger + /// this operation as well, and the navigation id is the same as the original + /// one. + /// + /// Navigations will be blocked until all `FrameNavigationStarting` event + /// handlers return. + /// + /// \snippet SettingsComponent.cpp FrameNavigationStarting + HRESULT add_FrameNavigationStarting( + [in] ICoreWebView2NavigationStartingEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_FrameNavigationStarting`. + HRESULT remove_FrameNavigationStarting( + [in] EventRegistrationToken token); + + /// Add an event handler for the `FrameNavigationCompleted` event. + /// `FrameNavigationCompleted` triggers when a child frame has completely + /// loaded (concurrently when `body.onload` has triggered) or loading stopped with error. + /// + /// \snippet ControlComponent.cpp FrameNavigationCompleted + HRESULT add_FrameNavigationCompleted( + [in] ICoreWebView2NavigationCompletedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_FrameNavigationCompleted`. + HRESULT remove_FrameNavigationCompleted( + [in] EventRegistrationToken token); + + /// Add an event handler for the `ScriptDialogOpening` event. + /// `ScriptDialogOpening` runs when a JavaScript dialog (`alert`, `confirm`, + /// `prompt`, or `beforeunload`) displays for the webview. This event only + /// triggers if the `ICoreWebView2Settings::AreDefaultScriptDialogsEnabled` + /// property is set to `FALSE`. The `ScriptDialogOpening` event suppresses + /// dialogs or replaces default dialogs with custom dialogs. + /// + /// If a deferral is not taken on the event args, the subsequent scripts are + /// blocked until the event handler returns. If a deferral is taken, the + /// scripts are blocked until the deferral is completed. + /// + /// \snippet SettingsComponent.cpp ScriptDialogOpening + HRESULT add_ScriptDialogOpening( + [in] ICoreWebView2ScriptDialogOpeningEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ScriptDialogOpening`. + HRESULT remove_ScriptDialogOpening( + [in] EventRegistrationToken token); + + /// Add an event handler for the `PermissionRequested` event. + /// `PermissionRequested` runs when content in a WebView requests permission + /// to access some privileged resources. + /// + /// If a deferral is not taken on the event args, the subsequent scripts are + /// blocked until the event handler returns. If a deferral is taken, the + /// scripts are blocked until the deferral is completed. + /// + /// \snippet SettingsComponent.cpp PermissionRequested0 + /// \snippet SettingsComponent.cpp PermissionRequested1 + HRESULT add_PermissionRequested( + [in] ICoreWebView2PermissionRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_PermissionRequested`. + HRESULT remove_PermissionRequested( + [in] EventRegistrationToken token); + + /// Add an event handler for the `ProcessFailed` event. + /// `ProcessFailed` runs when any of the processes in the + /// [WebView2 Process Group](/microsoft-edge/webview2/concepts/process-model?tabs=csharp#processes-in-the-webview2-runtime) + /// encounters one of the following conditions: + /// + /// Condition | Details + /// ---|--- + /// Unexpected exit | The process indicated by the event args has exited unexpectedly (usually due to a crash). The failure might or might not be recoverable and some failures are auto-recoverable. + /// Unresponsiveness | The process indicated by the event args has become unresponsive to user input. This is only reported for renderer processes, and will run every few seconds until the process becomes responsive again. + /// + /// \> [!NOTE]\n\> When the failing process is the browser process, a + /// `ICoreWebView2Environment5::BrowserProcessExited` event will run too. + /// + /// Your application can use `ICoreWebView2ProcessFailedEventArgs` and + /// `ICoreWebView2ProcessFailedEventArgs2` to identify which condition and + /// process the event is for, and to collect diagnostics and handle recovery + /// if necessary. For more details about which cases need to be handled by + /// your application, see `COREWEBVIEW2_PROCESS_FAILED_KIND`. + /// + /// \snippet ProcessComponent.cpp ProcessFailed + HRESULT add_ProcessFailed( + [in] ICoreWebView2ProcessFailedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ProcessFailed`. + HRESULT remove_ProcessFailed( + [in] EventRegistrationToken token); + + /// Add the provided JavaScript to a list of scripts that should be run after + /// the global object has been created, but before the HTML document has + /// been parsed and before any other script included by the HTML document is + /// run. This method injects a script that runs on all top-level document + /// and child frame page navigations. This method runs asynchronously, and + /// you must wait for the completion handler to finish before the injected + /// script is ready to run. When this method completes, the `Invoke` method + /// of the handler is run with the `id` of the injected script. `id` is a + /// string. To remove the injected script, use + /// `RemoveScriptToExecuteOnDocumentCreated`. + /// + /// If the method is run in add_NewWindowRequested handler it should be called + /// before the new window is set. If called after setting the NewWindow property, the initial script + /// may or may not apply to the initial navigation and may only apply to the subsequent navigation. + /// For more details see `ICoreWebView2NewWindowRequestedEventArgs::put_NewWindow`. + /// + /// \> [!NOTE]\n\> If an HTML document is running in a sandbox of some kind using + /// [sandbox](https://developer.mozilla.org/docs/Web/HTML/Element/iframe#attr-sandbox) + /// properties or the + /// [Content-Security-Policy](https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Security-Policy) + /// HTTP header affects the script that runs. For example, if the + /// `allow-modals` keyword is not set then requests to run the `alert` + /// function are ignored. + /// + /// \snippet ScriptComponent.cpp AddScriptToExecuteOnDocumentCreated + HRESULT AddScriptToExecuteOnDocumentCreated( + [in] LPCWSTR javaScript, + [in] ICoreWebView2AddScriptToExecuteOnDocumentCreatedCompletedHandler* handler); + + /// Remove the corresponding JavaScript added using + /// `AddScriptToExecuteOnDocumentCreated` with the specified script ID. The + /// script ID should be the one returned by the `AddScriptToExecuteOnDocumentCreated`. + /// Both use `AddScriptToExecuteOnDocumentCreated` and this method in `NewWindowRequested` + /// event handler at the same time sometimes causes trouble. Since invalid scripts will + /// be ignored, the script IDs you got may not be valid anymore. + HRESULT RemoveScriptToExecuteOnDocumentCreated([in] LPCWSTR id); + + /// Run JavaScript code from the javascript parameter in the current + /// top-level document rendered in the WebView. The result of evaluating + /// the provided JavaScript is used in this parameter. The result value is + /// a JSON encoded string. If the result is undefined, contains a reference + /// cycle, or otherwise is not able to be encoded into JSON, then the result + /// is considered to be null, which is encoded in JSON as the string "null". + /// + /// \> [!NOTE]\n\> A function that has no explicit return value returns undefined. If the + /// script that was run throws an unhandled exception, then the result is + /// also "null". This method is applied asynchronously. If the method is + /// run after the `NavigationStarting` event during a navigation, the script + /// runs in the new document when loading it, around the time + /// `ContentLoading` is run. This operation executes the script even if + /// `ICoreWebView2Settings::IsScriptEnabled` is set to `FALSE`. + /// + /// \snippet ScriptComponent.cpp ExecuteScript + HRESULT ExecuteScript( + [in] LPCWSTR javaScript, + [in] ICoreWebView2ExecuteScriptCompletedHandler* handler); + + /// Capture an image of what WebView is displaying. Specify the format of + /// the image with the `imageFormat` parameter. The resulting image binary + /// data is written to the provided `imageStream` parameter. When + /// `CapturePreview` finishes writing to the stream, the `Invoke` method on + /// the provided `handler` parameter is run. This method fails if called + /// before the first ContentLoading event. For example if this is called in + /// the NavigationStarting event for the first navigation it will fail. + /// For subsequent navigations, the method may not fail, but will not capture + /// an image of a given webpage until the ContentLoading event has been fired + /// for it. Any call to this method prior to that will result in a capture of + /// the page being navigated away from. + /// + /// \snippet FileComponent.cpp CapturePreview + HRESULT CapturePreview( + [in] COREWEBVIEW2_CAPTURE_PREVIEW_IMAGE_FORMAT imageFormat, + [in] IStream* imageStream, + [in] ICoreWebView2CapturePreviewCompletedHandler* handler); + + /// Reload the current page. This is similar to navigating to the URI of + /// current top level document including all navigation events firing and + /// respecting any entries in the HTTP cache. But, the back or forward + /// history are not modified. + HRESULT Reload(); + + /// Post the specified webMessage to the top level document in this WebView. + /// The main page receives the message by subscribing to the `message` event of the + /// `window.chrome.webview` of the page document. + /// + /// ```cpp + /// window.chrome.webview.addEventListener('message', handler) + /// window.chrome.webview.removeEventListener('message', handler) + /// ``` + /// + /// The event args is an instance of `MessageEvent`. The + /// `ICoreWebView2Settings::IsWebMessageEnabled` setting must be `TRUE` or + /// the web message will not be sent. The `data` property of the event + /// arg is the `webMessage` string parameter parsed as a JSON string into a + /// JavaScript object. The `source` property of the event arg is a reference + /// to the `window.chrome.webview` object. For information about sending + /// messages from the HTML document in the WebView to the host, navigate to + /// [add_WebMessageReceived](/microsoft-edge/webview2/reference/win32/icorewebview2#add_webmessagereceived). + /// The message is delivered asynchronously. If a navigation occurs before + /// the message is posted to the page, the message is discarded. + /// + /// \snippet ScenarioWebMessage.cpp WebMessageReceived + HRESULT PostWebMessageAsJson([in] LPCWSTR webMessageAsJson); + + /// Posts a message that is a simple string rather than a JSON string + /// representation of a JavaScript object. This behaves in exactly the same + /// manner as `PostWebMessageAsJson`, but the `data` property of the event + /// arg of the `window.chrome.webview` message is a string with the same + /// value as `webMessageAsString`. Use this instead of + /// `PostWebMessageAsJson` if you want to communicate using simple strings + /// rather than JSON objects. + HRESULT PostWebMessageAsString([in] LPCWSTR webMessageAsString); + + /// Add an event handler for the `WebMessageReceived` event. + /// `WebMessageReceived` runs when the + /// `ICoreWebView2Settings::IsWebMessageEnabled` setting is set and the + /// top-level document of the WebView runs + /// `window.chrome.webview.postMessage`. The `postMessage` function is + /// `void postMessage(object)` where object is any object supported by JSON + /// conversion. + /// + /// \snippet assets\ScenarioWebMessage.html chromeWebView + /// + /// When the page calls `postMessage`, the object parameter is converted to a + /// JSON string and is posted asynchronously to the host process. This will + /// result in the handler's `Invoke` method being called with the JSON string + /// as a parameter. + /// + /// \snippet ScenarioWebMessage.cpp WebMessageReceived + /// + /// If the same page calls `postMessage` multiple times, the corresponding + /// `WebMessageReceived` events are guaranteed to be fired in the same order. + /// However, if multiple frames call `postMessage`, there is no guaranteed + /// order. In addition, `WebMessageReceived` events caused by calls to + /// `postMessage` are not guaranteed to be sequenced with events caused by DOM + /// APIs. For example, if the page runs + /// + /// ```javascript + /// chrome.webview.postMessage("message"); + /// window.open(); + /// ``` + /// + /// then the `NewWindowRequested` event might be fired before the + /// `WebMessageReceived` event. If you need the `WebMessageReceived` event + /// to happen before anything else, then in the `WebMessageReceived` handler + /// you can post a message back to the page and have the page wait until it + /// receives that message before continuing. + HRESULT add_WebMessageReceived( + [in] ICoreWebView2WebMessageReceivedEventHandler* handler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_WebMessageReceived`. + HRESULT remove_WebMessageReceived( + [in] EventRegistrationToken token); + + /// Runs an asynchronous `DevToolsProtocol` method. For more information + /// about available methods, navigate to + /// [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/tot) + /// . The `methodName` parameter is the full name of the method in the + /// `{domain}.{method}` format. The `parametersAsJson` parameter is a JSON + /// formatted string containing the parameters for the corresponding method. + /// The `Invoke` method of the `handler` is run when the method + /// asynchronously completes. `Invoke` is run with the return object of the + /// method as a JSON string. This function returns E_INVALIDARG if the `methodName` is + /// unknown or the `parametersAsJson` has an error. In the case of such an error, the + /// `returnObjectAsJson` parameter of the handler will include information + /// about the error. + /// Note even though WebView2 dispatches the CDP messages in the order called, + /// CDP method calls may be processed out of order. + /// If you require CDP methods to run in a particular order, you should wait + /// for the previous method's completed handler to run before calling the + /// next method. + /// + /// \snippet ScriptComponent.cpp CallDevToolsProtocolMethod + HRESULT CallDevToolsProtocolMethod( + [in] LPCWSTR methodName, + [in] LPCWSTR parametersAsJson, + [in] ICoreWebView2CallDevToolsProtocolMethodCompletedHandler* handler); + + /// The process ID of the browser process that hosts the WebView. + [propget] HRESULT BrowserProcessId([out, retval] UINT32* value); + + /// `TRUE` if the WebView is able to navigate to a previous page in the + /// navigation history. If `CanGoBack` changes value, the `HistoryChanged` + /// event runs. + [propget] HRESULT CanGoBack([out, retval] BOOL* canGoBack); + + /// `TRUE` if the WebView is able to navigate to a next page in the + /// navigation history. If `CanGoForward` changes value, the + /// `HistoryChanged` event runs. + [propget] HRESULT CanGoForward([out, retval] BOOL* canGoForward); + + /// Navigates the WebView to the previous page in the navigation history. + HRESULT GoBack(); + + /// Navigates the WebView to the next page in the navigation history. + HRESULT GoForward(); + + /// Get a DevTools Protocol event receiver that allows you to subscribe to a + /// DevTools Protocol event. The `eventName` parameter is the full name of + /// the event in the format `{domain}.{event}`. For more information about + /// DevTools Protocol events description and event args, navigate to + /// [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/tot). + /// + /// \snippet ScriptComponent.cpp DevToolsProtocolEventReceived + HRESULT GetDevToolsProtocolEventReceiver( + [in] LPCWSTR eventName, + [out, retval] ICoreWebView2DevToolsProtocolEventReceiver** receiver); + + /// Stop all navigations and pending resource fetches. Does not stop scripts. + HRESULT Stop(); + + /// Add an event handler for the `NewWindowRequested` event. + /// `NewWindowRequested` runs when content inside the WebView requests to + /// open a new window, such as through `window.open`. The app can pass a + /// target WebView that is considered the opened window or mark the event as + /// `Handled`, in which case WebView2 does not open a window. + /// If either `Handled` or `NewWindow` properties are not set, the target + /// content will be opened on a popup window. + /// + /// If a deferral is not taken on the event args, scripts that resulted in the + /// new window that are requested are blocked until the event handler returns. + /// If a deferral is taken, then scripts are blocked until the deferral is + /// completed or new window is set. + /// + /// For more details and considerations on the target WebView to be supplied + /// at the opened window, see `ICoreWebView2NewWindowRequestedEventArgs::put_NewWindow`. + /// + /// \snippet AppWindow.cpp NewWindowRequested + HRESULT add_NewWindowRequested( + [in] ICoreWebView2NewWindowRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NewWindowRequested`. + HRESULT remove_NewWindowRequested( + [in] EventRegistrationToken token); + + /// Add an event handler for the `DocumentTitleChanged` event. + /// `DocumentTitleChanged` runs when the `DocumentTitle` property of the + /// WebView changes and may run before or after the `NavigationCompleted` + /// event. + /// + /// \snippet FileComponent.cpp DocumentTitleChanged + HRESULT add_DocumentTitleChanged( + [in] ICoreWebView2DocumentTitleChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_DocumentTitleChanged`. + HRESULT remove_DocumentTitleChanged( + [in] EventRegistrationToken token); + + /// The title for the current top-level document. If the document has no + /// explicit title or is otherwise empty, a default that may or may not match + /// the URI of the document is used. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT DocumentTitle([out, retval] LPWSTR* title); + + /// Add the provided host object to script running in the WebView with the + /// specified name. Host objects are exposed as host object proxies using + /// `window.chrome.webview.hostObjects.{name}`. Host object proxies are + /// promises and resolves to an object representing the host object. The + /// promise is rejected if the app has not added an object with the name. + /// When JavaScript code access a property or method of the object, a promise + /// is return, which resolves to the value returned from the host for the + /// property or method, or rejected in case of error, for example, no + /// property or method on the object or parameters are not valid. + /// + /// \> [!NOTE]\n\> While simple types, `IDispatch` and array are supported, and + /// `IUnknown` objects that also implement `IDispatch` are treated as `IDispatch`, + /// generic `IUnknown`, `VT_DECIMAL`, or `VT_RECORD` variant is not supported. + /// Remote JavaScript objects like callback functions are represented as an + /// `VT_DISPATCH` `VARIANT` with the object implementing `IDispatch`. The + /// JavaScript callback method may be invoked using `DISPID_VALUE` for the + /// `DISPID`. Such callback method invocations will return immediately and will + /// not wait for the JavaScript function to run and so will not provide the return + /// value of the JavaScript function. + /// Nested arrays are supported up to a depth of 3. Arrays of by + /// reference types are not supported. `VT_EMPTY` and `VT_NULL` are mapped + /// into JavaScript as `null`. In JavaScript, `null` and undefined are + /// mapped to `VT_EMPTY`. + /// + /// Additionally, all host objects are exposed as + /// `window.chrome.webview.hostObjects.sync.{name}`. Here the host objects + /// are exposed as synchronous host object proxies. These are not promises + /// and function runtimes or property access synchronously block running + /// script waiting to communicate cross process for the host code to run. + /// Accordingly the result may have reliability issues and it is recommended + /// that you use the promise-based asynchronous + /// `window.chrome.webview.hostObjects.{name}` API. + /// + /// Synchronous host object proxies and asynchronous host object proxies may + /// both use a proxy to the same host object. Remote changes made by one + /// proxy propagates to any other proxy of that same host object whether + /// the other proxies and synchronous or asynchronous. + /// + /// While JavaScript is blocked on a synchronous run to native code, that + /// native code is unable to run back to JavaScript. Attempts to do so fail + /// with `HRESULT_FROM_WIN32(ERROR_POSSIBLE_DEADLOCK)`. + /// + /// Host object proxies are JavaScript Proxy objects that intercept all + /// property get, property set, and method invocations. Properties or methods + /// that are a part of the Function or Object prototype are run locally. + /// Additionally any property or method in the + /// `chrome.webview.hostObjects.options.forceLocalProperties` + /// array are also run locally. This defaults to including optional methods + /// that have meaning in JavaScript like `toJSON` and `Symbol.toPrimitive`. + /// Add more to the array as required. + /// + /// The `chrome.webview.hostObjects.cleanupSome` method performs a best + /// effort garbage collection on host object proxies. + /// + /// The `chrome.webview.hostObjects.options` object provides the ability to + /// change some functionality of host objects. + /// + /// Options property | Details + /// ---|--- + /// `forceLocalProperties` | This is an array of host object property names that will be run locally, instead of being called on the native host object. This defaults to `then`, `toJSON`, `Symbol.toString`, and `Symbol.toPrimitive`. You can add other properties to specify that they should be run locally on the javascript host object proxy. + /// `log` | This is a callback that will be called with debug information. For example, you can set this to `console.log.bind(console)` to have it print debug information to the console to help when troubleshooting host object usage. By default this is null. + /// `shouldSerializeDates` | By default this is false, and javascript Date objects will be sent to host objects as a string using `JSON.stringify`. You can set this property to true to have Date objects properly serialize as a `VT_DATE` when sending to the native host object, and have `VT_DATE` properties and return values create a javascript Date object. + /// `defaultSyncProxy` | When calling a method on a synchronous proxy, the result should also be a synchronous proxy. But in some cases, the sync/async context is lost (for example, when providing to native code a reference to a function, and then calling that function in native code). In these cases, the proxy will be asynchronous, unless this property is set. + /// `forceAsyncMethodMatches ` | This is an array of regular expressions. When calling a method on a synchronous proxy, the method call will be performed asynchronously if the method name matches a string or regular expression in this array. Setting this value to `Async` will make any method that ends with Async be an asynchronous method call. If an async method doesn't match here and isn't forced to be asynchronous, the method will be invoked synchronously, blocking execution of the calling JavaScript and then returning the resolution of the promise, rather than returning a promise. + /// `ignoreMemberNotFoundError` | By default, an exception is thrown when attempting to get the value of a proxy property that doesn't exist on the corresponding native class. Setting this property to `true` switches the behavior to match Chakra WinRT projection (and general JavaScript) behavior of returning `undefined` with no error. + /// + /// Host object proxies additionally have the following methods which run + /// locally. + /// + /// Method name | Details + /// ---|--- + ///`applyHostFunction`, `getHostProperty`, `setHostProperty` | Perform a method invocation, property get, or property set on the host object. Use the methods to explicitly force a method or property to run remotely if a conflicting local method or property exists. For instance, `proxy.toString()` runs the local `toString` method on the proxy object. But proxy.applyHostFunction('toString') runs `toString` on the host proxied object instead. + ///`getLocalProperty`, `setLocalProperty` | Perform property get, or property set locally. Use the methods to force getting or setting a property on the host object proxy rather than on the host object it represents. For instance, `proxy.unknownProperty` gets the property named `unknownProperty` from the host proxied object. But proxy.getLocalProperty('unknownProperty') gets the value of the property `unknownProperty` on the proxy object. + ///`sync` | Asynchronous host object proxies expose a sync method which returns a promise for a synchronous host object proxy for the same host object. For example, `chrome.webview.hostObjects.sample.methodCall()` returns an asynchronous host object proxy. Use the `sync` method to obtain a synchronous host object proxy instead: `const syncProxy = await chrome.webview.hostObjects.sample.methodCall().sync()`. + ///`async` | Synchronous host object proxies expose an async method which blocks and returns an asynchronous host object proxy for the same host object. For example, `chrome.webview.hostObjects.sync.sample.methodCall()` returns a synchronous host object proxy. Running the `async` method on this blocks and then returns an asynchronous host object proxy for the same host object: `const asyncProxy = chrome.webview.hostObjects.sync.sample.methodCall().async()`. + ///`then` | Asynchronous host object proxies have a `then` method. Allows proxies to be awaitable. `then` returns a promise that resolves with a representation of the host object. If the proxy represents a JavaScript literal, a copy of that is returned locally. If the proxy represents a function, a non-awaitable proxy is returned. If the proxy represents a JavaScript object with a mix of literal properties and function properties, the a copy of the object is returned with some properties as host object proxies. + /// + /// All other property and method invocations (other than the above Remote + /// object proxy methods, `forceLocalProperties` list, and properties on + /// Function and Object prototypes) are run remotely. Asynchronous host + /// object proxies return a promise representing asynchronous completion of + /// remotely invoking the method, or getting the property. The promise + /// resolves after the remote operations complete and the promises resolve to + /// the resulting value of the operation. Synchronous host object proxies + /// work similarly, but block running JavaScript and wait for the remote + /// operation to complete. + /// + /// Setting a property on an asynchronous host object proxy works slightly + /// differently. The set returns immediately and the return value is the + /// value that is set. This is a requirement of the JavaScript Proxy object. + /// If you need to asynchronously wait for the property set to complete, use + /// the `setHostProperty` method which returns a promise as described above. + /// Synchronous object property set property synchronously blocks until the + /// property is set. + /// + /// For example, suppose you have a COM object with the following interface. + /// + /// \snippet HostObjectSample.idl AddHostObjectInterface + /// + /// Add an instance of this interface into your JavaScript with + /// `AddHostObjectToScript`. In this case, name it `sample`. + /// + /// \snippet ScenarioAddHostObject.cpp AddHostObjectToScript + /// + /// In the HTML document, use the COM object using + /// `chrome.webview.hostObjects.sample`. + /// Note that `CoreWebView2.AddHostObjectToScript` only applies to the + /// top-level document and not to frames. To add host objects to frames use + /// `CoreWebView2Frame.AddHostObjectToScript`. + /// + /// \snippet assets\ScenarioAddHostObject.html HostObjectUsage + /// + /// Exposing host objects to script has security risk. For more information + /// about best practices, navigate to + /// [Best practices for developing secure WebView2 applications](/microsoft-edge/webview2/concepts/security). + HRESULT AddHostObjectToScript([in] LPCWSTR name, [in] VARIANT* object); + + /// Remove the host object specified by the name so that it is no longer + /// accessible from JavaScript code in the WebView. While new access + /// attempts are denied, if the object is already obtained by JavaScript code + /// in the WebView, the JavaScript code continues to have access to that + /// object. Run this method for a name that is already removed or never + /// added fails. + HRESULT RemoveHostObjectFromScript([in] LPCWSTR name); + + /// Opens the DevTools window for the current document in the WebView. Does + /// nothing if run when the DevTools window is already open. + HRESULT OpenDevToolsWindow(); + + /// Add an event handler for the `ContainsFullScreenElementChanged` event. + /// `ContainsFullScreenElementChanged` triggers when the + /// `ContainsFullScreenElement` property changes. An HTML element inside the + /// WebView may enter fullscreen to the size of the WebView or leave + /// fullscreen. This event is useful when, for example, a video element + /// requests to go fullscreen. The listener of + /// `ContainsFullScreenElementChanged` may resize the WebView in response. + /// + /// \snippet AppWindow.cpp ContainsFullScreenElementChanged + HRESULT add_ContainsFullScreenElementChanged( + [in] ICoreWebView2ContainsFullScreenElementChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_ContainsFullScreenElementChanged`. + HRESULT remove_ContainsFullScreenElementChanged( + [in] EventRegistrationToken token); + + /// Indicates if the WebView contains a fullscreen HTML element. + [propget] HRESULT ContainsFullScreenElement( + [out, retval] BOOL* containsFullScreenElement); + + /// Add an event handler for the `WebResourceRequested` event. + /// `WebResourceRequested` runs when the WebView is performing a URL request + /// to a matching URL and resource context filter that was added with + /// `AddWebResourceRequestedFilter`. At least one filter must be added for + /// the event to run. + /// + /// The web resource requested may be blocked until the event handler returns + /// if a deferral is not taken on the event args. If a deferral is taken, + /// then the web resource requested is blocked until the deferral is + /// completed. + /// + /// If this event is subscribed in the add_NewWindowRequested handler it should be called + /// after the new window is set. For more details see `ICoreWebView2NewWindowRequestedEventArgs::put_NewWindow`. + /// + /// This event is by default raised for file, http, and https URI schemes. + /// This is also raised for registered custom URI schemes. For more details + /// see `ICoreWebView2CustomSchemeRegistration`. + /// + /// \snippet SettingsComponent.cpp WebResourceRequested0 + /// \snippet SettingsComponent.cpp WebResourceRequested1 + HRESULT add_WebResourceRequested( + [in] ICoreWebView2WebResourceRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_WebResourceRequested`. + HRESULT remove_WebResourceRequested( + [in] EventRegistrationToken token); + + /// Adds a URI and resource context filter for the `WebResourceRequested` + /// event. A web resource request with a resource context that matches this + /// filter's resource context and a URI that matches this filter's URI + /// wildcard string will be raised via the `WebResourceRequested` event. + /// + /// The `uri` parameter value is a wildcard string matched against the URI + /// of the web resource request. This is a glob style + /// wildcard string in which a `*` matches zero or more characters and a `?` + /// matches exactly one character. + /// These wildcard characters can be escaped using a backslash just before + /// the wildcard character in order to represent the literal `*` or `?`. + /// + /// The matching occurs over the URI as a whole string and not limiting + /// wildcard matches to particular parts of the URI. + /// The wildcard filter is compared to the URI after the URI has been + /// normalized, any URI fragment has been removed, and non-ASCII hostnames + /// have been converted to punycode. + /// + /// Specifying a `nullptr` for the uri is equivalent to an empty string which + /// matches no URIs. + /// + /// For more information about resource context filters, navigate to + /// [COREWEBVIEW2_WEB_RESOURCE_CONTEXT](/microsoft-edge/webview2/reference/win32/webview2-idl#corewebview2_web_resource_context). + /// + /// | URI Filter String | Request URI | Match | Notes | + /// | ---- | ---- | ---- | ---- | + /// | `*` | `https://contoso.com/a/b/c` | Yes | A single * will match all URIs | + /// | `*://contoso.com/*` | `https://contoso.com/a/b/c` | Yes | Matches everything in contoso.com across all schemes | + /// | `*://contoso.com/*` | `https://example.com/?https://contoso.com/` | Yes | But also matches a URI with just the same text anywhere in the URI | + /// | `example` | `https://contoso.com/example` | No | The filter does not perform partial matches | + /// | `*example` | `https://contoso.com/example` | Yes | The filter matches across URI parts | + /// | `*example` | `https://contoso.com/path/?example` | Yes | The filter matches across URI parts | + /// | `*example` | `https://contoso.com/path/?query#example` | No | The filter is matched against the URI with no fragment | + /// | `*example` | `https://example` | No | The URI is normalized before filter matching so the actual URI used for comparison is `https://example/` | + /// | `*example/` | `https://example` | Yes | Just like above, but this time the filter ends with a / just like the normalized URI | + /// | `https://xn--qei.example/` | `https://❤.example/` | Yes | Non-ASCII hostnames are normalized to punycode before wildcard comparison | + /// | `https://❤.example/` | `https://xn--qei.example/` | No | Non-ASCII hostnames are normalized to punycode before wildcard comparison | + HRESULT AddWebResourceRequestedFilter( + [in] LPCWSTR const uri, + [in] COREWEBVIEW2_WEB_RESOURCE_CONTEXT const resourceContext); + + /// Removes a matching WebResource filter that was previously added for the + /// `WebResourceRequested` event. If the same filter was added multiple + /// times, then it must be removed as many times as it was added for the + /// removal to be effective. Returns `E_INVALIDARG` for a filter that was + /// never added. + HRESULT RemoveWebResourceRequestedFilter( + [in] LPCWSTR const uri, + [in] COREWEBVIEW2_WEB_RESOURCE_CONTEXT const resourceContext); + + /// Add an event handler for the `WindowCloseRequested` event. + /// `WindowCloseRequested` triggers when content inside the WebView + /// requested to close the window, such as after `window.close` is run. The + /// app should close the WebView and related app window if that makes sense + /// to the app. + /// + /// \snippet AppWindow.cpp WindowCloseRequested + HRESULT add_WindowCloseRequested( + [in] ICoreWebView2WindowCloseRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_WindowCloseRequested`. + HRESULT remove_WindowCloseRequested( + [in] EventRegistrationToken token); +} + +/// A continuation of the ICoreWebView2 interface. +[uuid(9E8F0CF8-E670-4B5E-B2BC-73E061E3184C), object, pointer_default(unique)] +interface ICoreWebView2_2 : ICoreWebView2 { + /// Add an event handler for the WebResourceResponseReceived event. + /// WebResourceResponseReceived is raised when the WebView receives the + /// response for a request for a web resource (any URI resolution performed by + /// the WebView; such as HTTP/HTTPS, file and data requests from redirects, + /// navigations, declarations in HTML, implicit favicon lookups, and fetch API + /// usage in the document). The host app can use this event to view the actual + /// request and response for a web resource. There is no guarantee about the + /// order in which the WebView processes the response and the host app's + /// handler runs. The app's handler will not block the WebView from processing + /// the response. + /// \snippet ScenarioAuthentication.cpp WebResourceResponseReceived + HRESULT add_WebResourceResponseReceived( + [in] ICoreWebView2WebResourceResponseReceivedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + /// Remove an event handler previously added with + /// add_WebResourceResponseReceived. + HRESULT remove_WebResourceResponseReceived( + [in] EventRegistrationToken token); + + /// Navigates using a constructed WebResourceRequest object. This lets you + /// provide post data or additional request headers during navigation. + /// The headers in the WebResourceRequest override headers + /// added by WebView2 runtime except for Cookie headers. + /// Method can only be either "GET" or "POST". Provided post data will only + /// be sent only if the method is "POST" and the uri scheme is HTTP(S). + /// \snippet ScenarioNavigateWithWebResourceRequest.cpp NavigateWithWebResourceRequest + HRESULT NavigateWithWebResourceRequest([in] ICoreWebView2WebResourceRequest* request); + + /// Add an event handler for the DOMContentLoaded event. + /// DOMContentLoaded is raised when the initial html document has been parsed. + /// This aligns with the document's DOMContentLoaded event in html. + /// + /// \snippet ScenarioDOMContentLoaded.cpp DOMContentLoaded + HRESULT add_DOMContentLoaded( + [in] ICoreWebView2DOMContentLoadedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with add_DOMContentLoaded. + HRESULT remove_DOMContentLoaded( + [in] EventRegistrationToken token); + + /// Gets the cookie manager object associated with this ICoreWebView2. + /// See ICoreWebView2CookieManager. + /// + /// \snippet ScenarioCookieManagement.cpp CookieManager + [propget] HRESULT CookieManager([out, retval] ICoreWebView2CookieManager** cookieManager); + + /// Exposes the CoreWebView2Environment used to create this CoreWebView2. + [propget] HRESULT Environment([out, retval] ICoreWebView2Environment** environment); +} + +/// A continuation of the ICoreWebView2_2 interface. +[uuid(A0D6DF20-3B92-416D-AA0C-437A9C727857), object, pointer_default(unique)] +interface ICoreWebView2_3 : ICoreWebView2_2 { + /// An app may call the `TrySuspend` API to have the WebView2 consume less memory. + /// This is useful when a Win32 app becomes invisible, or when a Universal Windows + /// Platform app is being suspended, during the suspended event handler before completing + /// the suspended event. + /// The CoreWebView2Controller's IsVisible property must be false when the API is called. + /// Otherwise, the API fails with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`. + /// Suspending is similar to putting a tab to sleep in the Edge browser. Suspending pauses + /// WebView script timers and animations, minimizes CPU usage for the associated + /// browser renderer process and allows the operating system to reuse the memory that was + /// used by the renderer process for other processes. + /// Note that Suspend is best effort and considered completed successfully once the request + /// is sent to browser renderer process. If there is a running script, the script will continue + /// to run and the renderer process will be suspended after that script is done. + /// See [Sleeping Tabs FAQ](https://techcommunity.microsoft.com/t5/articles/sleeping-tabs-faq/m-p/1705434) + /// for conditions that might prevent WebView from being suspended. In those situations, + /// the completed handler will be invoked with isSuccessful as false and errorCode as S_OK. + /// The WebView will be automatically resumed when it becomes visible. Therefore, the + /// app normally does not have to call `Resume` explicitly. + /// The app can call `Resume` and then `TrySuspend` periodically for an invisible WebView so that + /// the invisible WebView can sync up with latest data and the page ready to show fresh content + /// when it becomes visible. + /// All WebView APIs can still be accessed when a WebView is suspended. Some APIs like Navigate + /// will auto resume the WebView. To avoid unexpected auto resume, check `IsSuspended` property + /// before calling APIs that might change WebView state. + /// + /// \snippet ViewComponent.cpp ToggleIsVisibleOnMinimize + /// + /// \snippet ViewComponent.cpp Suspend + /// + HRESULT TrySuspend([in] ICoreWebView2TrySuspendCompletedHandler* handler); + + /// Resumes the WebView so that it resumes activities on the web page. + /// This API can be called while the WebView2 controller is invisible. + /// The app can interact with the WebView immediately after `Resume`. + /// WebView will be automatically resumed when it becomes visible. + /// + /// \snippet ViewComponent.cpp ToggleIsVisibleOnMinimize + /// + /// \snippet ViewComponent.cpp Resume + /// + HRESULT Resume(); + + /// Whether WebView is suspended. + /// `TRUE` when WebView is suspended, from the time when TrySuspend has completed + /// successfully until WebView is resumed. + [propget] HRESULT IsSuspended([out, retval] BOOL* isSuspended); + + /// Sets a mapping between a virtual host name and a folder path to make available to web sites + /// via that host name. + /// + /// After setting the mapping, documents loaded in the WebView can use HTTP or HTTPS URLs at + /// the specified host name specified by hostName to access files in the local folder specified + /// by folderPath. + /// + /// This mapping applies to both top-level document and iframe navigations as well as subresource + /// references from a document. This also applies to web workers including dedicated/shared worker + /// and service worker, for loading either worker scripts or subresources + /// (importScripts(), fetch(), XHR, etc.) issued from within a worker. + /// For virtual host mapping to work with service worker, please keep the virtual host name + /// mappings consistent among all WebViews sharing the same browser instance. As service worker + /// works independently of WebViews, we merge mappings from all WebViews when resolving virtual + /// host name, inconsistent mappings between WebViews would lead unexpected behavior. + /// + /// Due to a current implementation limitation, media files accessed using virtual host name can be + /// very slow to load. + /// As the resource loaders for the current page might have already been created and running, + /// changes to the mapping might not be applied to the current page and a reload of the page is + /// needed to apply the new mapping. + /// + /// Both absolute and relative paths are supported for folderPath. Relative paths are interpreted + /// as relative to the folder where the exe of the app is in. + /// + /// Note that the folderPath length must not exceed the Windows MAX_PATH limit. + /// + /// accessKind specifies the level of access to resources under the virtual host from other sites. + /// + /// For example, after calling + /// ```cpp + /// SetVirtualHostNameToFolderMapping( + /// L"appassets.example", L"assets", + /// COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_DENY); + /// ``` + /// navigating to `https://appassets.example/my-local-file.html` will + /// show the content from my-local-file.html in the assets subfolder located on disk under + /// the same path as the app's executable file. + /// + /// DOM elements that want to reference local files will have their host reference virtual host in the source. + /// If there are multiple folders being used, define one unique virtual host per folder. + /// For example, you can embed a local image like this + /// ```cpp + /// WCHAR c_navString[] = L""; + /// m_webView->NavigateToString(c_navString); + /// ``` + /// The example above shows the image wv2.png by resolving the folder mapping above. + /// + /// You should typically choose virtual host names that are never used by real sites. + /// If you own a domain such as example.com, another option is to use a subdomain reserved for + /// the app (like my-app.example.com). + /// + /// [RFC 6761](https://tools.ietf.org/html/rfc6761) has reserved several special-use domain + /// names that are guaranteed to not be used by real sites (for example, .example, .test, and + /// .invalid.) + /// + /// Note that using `.local` as the top-level domain name will work but can cause a delay + /// during navigations. You should avoid using `.local` if you can. + /// + /// Apps should use distinct domain names when mapping folder from different sources that + /// should be isolated from each other. For instance, the app might use app-file.example for + /// files that ship as part of the app, and book1.example might be used for files containing + /// books from a less trusted source that were previously downloaded and saved to the disk by + /// the app. + /// + /// The host name used in the APIs is canonicalized using Chromium's host name parsing logic + /// before being used internally. For more information see [HTML5 2.6 URLs](https://dev.w3.org/html5/spec-LC/urls.html). + /// + /// All host names that are canonicalized to the same string are considered identical. + /// For example, `EXAMPLE.COM` and `example.com` are treated as the same host name. + /// An international host name and its Punycode-encoded host name are considered the same host + /// name. There is no DNS resolution for host name and the trailing '.' is not normalized as + /// part of canonicalization. + /// + /// Therefore `example.com` and `example.com.` are treated as different host names. Similarly, + /// `virtual-host-name` and `virtual-host-name.example.com` are treated as different host names + /// even if the machine has a DNS suffix of `example.com`. + /// + /// Specify the minimal cross-origin access necessary to run the app. If there is not a need to + /// access local resources from other origins, use COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND_DENY. + /// + /// \snippet AppWindow.cpp AddVirtualHostNameToFolderMapping + /// + /// \snippet AppWindow.cpp LocalUrlUsage + HRESULT SetVirtualHostNameToFolderMapping( + [in] LPCWSTR hostName, + [in] LPCWSTR folderPath, + [in] COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND accessKind); + + /// Clears a host name mapping for local folder that was added by `SetVirtualHostNameToFolderMapping`. + HRESULT ClearVirtualHostNameToFolderMapping( + [in] LPCWSTR hostName); +} + +/// A continuation of the ICoreWebView2_3 interface to support FrameCreated and +/// DownloadStarting events. +[uuid(20d02d59-6df2-42dc-bd06-f98a694b1302), object, pointer_default(unique)] +interface ICoreWebView2_4 : ICoreWebView2_3 { + /// Raised when a new iframe is created. + /// Handle this event to get access to ICoreWebView2Frame objects. + /// Use ICoreWebView2Frame.add_Destroyed to listen for when this iframe goes + /// away. + HRESULT add_FrameCreated( + [in] ICoreWebView2FrameCreatedEventHandler * eventHandler, + [out] EventRegistrationToken * token); + + /// Remove an event handler previously added with add_FrameCreated. + HRESULT remove_FrameCreated([in] EventRegistrationToken token); + + /// Add an event handler for the `DownloadStarting` event. This event is + /// raised when a download has begun, blocking the default download dialog, + /// but not blocking the progress of the download. + /// + /// The host can choose to cancel a download, change the result file path, + /// and hide the default download dialog. + /// If the host chooses to cancel the download, the download is not saved, no + /// dialog is shown, and the state is changed to + /// COREWEBVIEW2_DOWNLOAD_STATE_INTERRUPTED with interrupt reason + /// COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_USER_CANCELED. Otherwise, the + /// download is saved to the default path after the event completes, + /// and default download dialog is shown if the host did not choose to hide it. + /// The host can change the visibility of the download dialog using the + /// `Handled` property. If the event is not handled, downloads complete + /// normally with the default dialog shown. + /// + /// \snippet ScenarioCustomDownloadExperience.cpp DownloadStarting + HRESULT add_DownloadStarting( + [in] ICoreWebView2DownloadStartingEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_DownloadStarting`. + HRESULT remove_DownloadStarting( + [in] EventRegistrationToken token); +} + +/// A continuation of the ICoreWebView2_4 interface to support ClientCertificateRequested +/// event. +[uuid(bedb11b8-d63c-11eb-b8bc-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2_5 : ICoreWebView2_4 { + /// Add an event handler for the ClientCertificateRequested event. + /// The ClientCertificateRequested event is raised when the WebView2 + /// is making a request to an HTTP server that needs a client certificate + /// for HTTP authentication. + /// Read more about HTTP client certificates at + /// [RFC 8446 The Transport Layer Security (TLS) Protocol Version 1.3](https://tools.ietf.org/html/rfc8446). + /// + /// With this event you have several options for responding to client certificate requests: + /// + /// Scenario | Handled | Cancel | SelectedCertificate + /// ---------------------------------------------------------- | ------- | ------ | ------------------- + /// Respond to server with a certificate | True | False | MutuallyTrustedCertificate value + /// Respond to server without certificate | True | False | null + /// Display default client certificate selection dialog prompt | False | False | n/a + /// Cancel the request | n/a | True | n/a + /// + /// If you don't handle the event, WebView2 will + /// show the default client certificate selection dialog prompt to user. + /// + /// \snippet SettingsComponent.cpp ClientCertificateRequested1 + /// \snippet ScenarioClientCertificateRequested.cpp ClientCertificateRequested2 + HRESULT add_ClientCertificateRequested( + [in] ICoreWebView2ClientCertificateRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with add_ClientCertificateRequested. + HRESULT remove_ClientCertificateRequested([in] EventRegistrationToken token); +} + +/// This interface is an extension of `ICoreWebView2_5` that manages opening +/// the browser task manager window. +[uuid(499aadac-d92c-4589-8a75-111bfc167795), object, pointer_default(unique)] +interface ICoreWebView2_6 : ICoreWebView2_5 { + /// Opens the Browser Task Manager view as a new window in the foreground. + /// If the Browser Task Manager is already open, this will bring it into + /// the foreground. WebView2 currently blocks the Shift+Esc shortcut for + /// opening the task manager. An end user can open the browser task manager + /// manually via the `Browser task manager` entry of the DevTools window's + /// title bar's context menu. + HRESULT OpenTaskManagerWindow(); +} + +/// This interface is an extension of `ICoreWebView2_6` that supports printing +/// to PDF. +[uuid(79c24d83-09a3-45ae-9418-487f32a58740), object, pointer_default(unique)] +interface ICoreWebView2_7 : ICoreWebView2_6 { + /// Print the current page to PDF asynchronously with the provided settings. + /// See `ICoreWebView2PrintSettings` for description of settings. Passing + /// nullptr for `printSettings` results in default print settings used. + /// + /// Use `resultFilePath` to specify the path to the PDF file. The host should + /// provide an absolute path, including file name. If the path + /// points to an existing file, the file will be overwritten. If the path is + /// not valid, the method fails with `E_INVALIDARG`. + /// + /// The async `PrintToPdf` operation completes when the data has been written + /// to the PDF file. At this time the + /// `ICoreWebView2PrintToPdfCompletedHandler` is invoked. If the + /// application exits before printing is complete, the file is not saved. + /// Only one `Printing` operation can be in progress at a time. If + /// `PrintToPdf` is called while a `PrintToPdf` or `PrintToPdfStream` or `Print` or + /// `ShowPrintUI` job is in progress, the completed handler is immediately invoked + /// with `isSuccessful` set to FALSE. + /// + /// \snippet FileComponent.cpp PrintToPdf + HRESULT PrintToPdf( + [in] LPCWSTR resultFilePath, + [in] ICoreWebView2PrintSettings* printSettings, + [in] ICoreWebView2PrintToPdfCompletedHandler* handler); +} + +/// This interface is an extension of `ICoreWebView2_7` that supports media features. +[uuid(E9632730-6E1E-43AB-B7B8-7B2C9E62E094), object, pointer_default(unique)] +interface ICoreWebView2_8 : ICoreWebView2_7 { + /// Adds an event handler for the `IsMutedChanged` event. + /// `IsMutedChanged` is raised when the IsMuted property changes value. + /// + /// \snippet AudioComponent.cpp IsMutedChanged + HRESULT add_IsMutedChanged( + [in] ICoreWebView2IsMutedChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_IsMutedChanged`. + HRESULT remove_IsMutedChanged( + [in] EventRegistrationToken token); + + /// Indicates whether all audio output from this CoreWebView2 is muted or not. + /// + /// \snippet AudioComponent.cpp ToggleIsMuted + [propget] HRESULT IsMuted([out, retval] BOOL* value); + + /// Sets the `IsMuted` property. + /// + /// \snippet AudioComponent.cpp ToggleIsMuted + [propput] HRESULT IsMuted([in] BOOL value); + + /// Adds an event handler for the `IsDocumentPlayingAudioChanged` event. + /// `IsDocumentPlayingAudioChanged` is raised when the IsDocumentPlayingAudio property changes value. + /// + /// \snippet AudioComponent.cpp IsDocumentPlayingAudioChanged + HRESULT add_IsDocumentPlayingAudioChanged( + [in] ICoreWebView2IsDocumentPlayingAudioChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_IsDocumentPlayingAudioChanged`. + HRESULT remove_IsDocumentPlayingAudioChanged( + [in] EventRegistrationToken token); + + /// Indicates whether any audio output from this CoreWebView2 is playing. + /// This property will be true if audio is playing even if IsMuted is true. + /// + /// \snippet AudioComponent.cpp IsDocumentPlayingAudio + [propget] HRESULT IsDocumentPlayingAudio([out, retval] BOOL* value); +} + +/// This interface is an extension of `ICoreWebView2_8` that default download +/// dialog positioning and anchoring. +[uuid(4d7b2eab-9fdc-468d-b998-a9260b5ed651), object, pointer_default(unique)] +interface ICoreWebView2_9 : ICoreWebView2_8 { + /// Raised when the `IsDefaultDownloadDialogOpen` property changes. This event + /// comes after the `DownloadStarting` event. Setting the `Handled` property + /// on the `DownloadStartingEventArgs` disables the default download dialog + /// and ensures that this event is never raised. + HRESULT add_IsDefaultDownloadDialogOpenChanged( + [in] ICoreWebView2IsDefaultDownloadDialogOpenChangedEventHandler* handler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_IsDefaultDownloadDialogOpenChanged`. + HRESULT remove_IsDefaultDownloadDialogOpenChanged( + [in] EventRegistrationToken token); + + /// `TRUE` if the default download dialog is currently open. The value of this + /// property changes only when the default download dialog is explicitly + /// opened or closed. Hiding the WebView implicitly hides the dialog, but does + /// not change the value of this property. + [propget] HRESULT IsDefaultDownloadDialogOpen([out, retval] BOOL* value); + + /// Open the default download dialog. If the dialog is opened before there + /// are recent downloads, the dialog shows all past downloads for the + /// current profile. Otherwise, the dialog shows only the recent downloads + /// with a "See more" button for past downloads. Calling this method raises + /// the `IsDefaultDownloadDialogOpenChanged` event if the dialog was closed. + /// No effect if the dialog is already open. + /// + /// \snippet ViewComponent.cpp ToggleDefaultDownloadDialog + HRESULT OpenDefaultDownloadDialog(); + + /// Close the default download dialog. Calling this method raises the + /// `IsDefaultDownloadDialogOpenChanged` event if the dialog was open. No + /// effect if the dialog is already closed. + HRESULT CloseDefaultDownloadDialog(); + + /// Get the default download dialog corner alignment. + [propget] HRESULT DefaultDownloadDialogCornerAlignment( + [out, retval] COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT* value); + + /// Set the default download dialog corner alignment. The dialog can be + /// aligned to any of the WebView corners (see + /// COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT). When the WebView + /// or dialog changes size, the dialog keeps its position relative to the + /// corner. The dialog may become partially or completely outside of the + /// WebView bounds if the WebView is small enough. Set the margin relative to + /// the corner with the `DefaultDownloadDialogMargin` property. The corner + /// alignment and margin should be set during initialization to ensure that + /// they are correctly applied when the layout is first computed, otherwise + /// they will not take effect until the next time the WebView position or size + /// is updated. + /// + /// \snippet ViewComponent.cpp SetDefaultDownloadDialogPosition + [propput] HRESULT DefaultDownloadDialogCornerAlignment( + [in] COREWEBVIEW2_DEFAULT_DOWNLOAD_DIALOG_CORNER_ALIGNMENT value); + + /// Get the default download dialog margin. + [propget] HRESULT DefaultDownloadDialogMargin([out, retval] POINT* value); + + /// Set the default download dialog margin relative to the WebView corner + /// specified by `DefaultDownloadDialogCornerAlignment`. The margin is a + /// point that describes the vertical and horizontal distances between the + /// chosen WebView corner and the default download dialog corner nearest to + /// it. Positive values move the dialog towards the center of the WebView from + /// the chosen WebView corner, and negative values move the dialog away from + /// it. Use (0, 0) to align the dialog to the WebView corner with no margin. + /// The corner alignment and margin should be set during initialization to + /// ensure that they are correctly applied when the layout is first computed, + /// otherwise they will not take effect until the next time the WebView + /// position or size is updated. + [propput] HRESULT DefaultDownloadDialogMargin([in] POINT value); +} + +/// This interface is an extension of `ICoreWebView2_9` that supports +/// BasicAuthenticationRequested event. +[uuid(b1690564-6f5a-4983-8e48-31d1143fecdb), object, pointer_default(unique)] +interface ICoreWebView2_10 : ICoreWebView2_9 { + /// Add an event handler for the BasicAuthenticationRequested event. + /// BasicAuthenticationRequested event is raised when WebView encounters a + /// Basic HTTP Authentication request as described in + /// https://developer.mozilla.org/docs/Web/HTTP/Authentication, a Digest + /// HTTP Authentication request as described in + /// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization#digest, + /// an NTLM authentication or a Proxy Authentication request. + /// + /// The host can provide a response with credentials for the authentication or + /// cancel the request. If the host sets the Cancel property to false but does not + /// provide either UserName or Password properties on the Response property, then + /// WebView2 will show the default authentication challenge dialog prompt to + /// the user. + /// + /// \snippet ScenarioAuthentication.cpp BasicAuthenticationRequested + HRESULT add_BasicAuthenticationRequested( + [in] ICoreWebView2BasicAuthenticationRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with add_BasicAuthenticationRequested. + HRESULT remove_BasicAuthenticationRequested( + [in] EventRegistrationToken token); +} + +/// This interface is an extension of `ICoreWebView2_10` that supports sessionId +/// for CDP method calls and ContextMenuRequested event. +[uuid(0be78e56-c193-4051-b943-23b460c08bdb), object, pointer_default(unique)] +interface ICoreWebView2_11 : ICoreWebView2_10 { + /// Runs an asynchronous `DevToolsProtocol` method for a specific session of + /// an attached target. + /// There could be multiple `DevToolsProtocol` targets in a WebView. + /// Besides the top level page, iframes from different origin and web workers + /// are also separate targets. Attaching to these targets allows interaction with them. + /// When the DevToolsProtocol is attached to a target, the connection is identified + /// by a sessionId. + /// To use this API, you must set the `flatten` parameter to true when calling + /// `Target.attachToTarget` or `Target.setAutoAttach` `DevToolsProtocol` method. + /// Using `Target.setAutoAttach` is recommended as that would allow you to attach + /// to dedicated worker targets, which are not discoverable via other APIs like + /// `Target.getTargets`. + /// For more information about targets and sessions, navigate to + /// [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/tot/Target). + /// For more information about available methods, navigate to + /// [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/tot) + /// The `sessionId` parameter is the sessionId for an attached target. + /// nullptr or empty string is treated as the session for the default target for the top page. + /// The `methodName` parameter is the full name of the method in the + /// `{domain}.{method}` format. The `parametersAsJson` parameter is a JSON + /// formatted string containing the parameters for the corresponding method. + /// The `Invoke` method of the `handler` is run when the method + /// asynchronously completes. `Invoke` is run with the return object of the + /// method as a JSON string. This function returns E_INVALIDARG if the `methodName` is + /// unknown or the `parametersAsJson` has an error. In the case of such an error, the + /// `returnObjectAsJson` parameter of the handler will include information + /// about the error. + /// + /// \snippet ScriptComponent.cpp DevToolsProtocolMethodMultiSession + /// + /// \snippet ScriptComponent.cpp CallDevToolsProtocolMethodForSession + HRESULT CallDevToolsProtocolMethodForSession( + [in] LPCWSTR sessionId, + [in] LPCWSTR methodName, + [in] LPCWSTR parametersAsJson, + [in] ICoreWebView2CallDevToolsProtocolMethodCompletedHandler* handler); + + /// Add an event handler for the `ContextMenuRequested` event. + /// `ContextMenuRequested` event is raised when a context menu is requested by the user + /// and the content inside WebView hasn't disabled context menus. + /// The host has the option to create their own context menu with the information provided in + /// the event or can add items to or remove items from WebView context menu. + /// If the host doesn't handle the event, WebView will display the default context menu. + /// + /// \snippet SettingsComponent.cpp EnableCustomMenu + HRESULT add_ContextMenuRequested( + [in] ICoreWebView2ContextMenuRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ContextMenuRequested`. + HRESULT remove_ContextMenuRequested( + [in] EventRegistrationToken token); +} + +/// This interface is an extension of `ICoreWebView2_11` that supports +/// StatusBarTextChanged event. +[uuid(35D69927-BCFA-4566-9349-6B3E0D154CAC), object, pointer_default(unique)] +interface ICoreWebView2_12 : ICoreWebView2_11 { + /// Add an event handler for the `StatusBarTextChanged` event. + /// `StatusBarTextChanged` fires when the WebView is showing a status message, + /// a URL, or an empty string (an indication to hide the status bar). + /// \snippet SettingsComponent.cpp StatusBarTextChanged + HRESULT add_StatusBarTextChanged( + [in] ICoreWebView2StatusBarTextChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_StatusBarTextChanged`. + HRESULT remove_StatusBarTextChanged([in] EventRegistrationToken token); + + /// The status message text. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT StatusBarText([out, retval] LPWSTR* value); +} + +/// This interface is an extension of `ICoreWebView2_12` that supports Profile +/// API. +[uuid(F75F09A8-667E-4983-88D6-C8773F315E84), object, pointer_default(unique)] +interface ICoreWebView2_13 : ICoreWebView2_12 { + /// The associated `ICoreWebView2Profile` object. If this CoreWebView2 was created with a + /// CoreWebView2ControllerOptions, the CoreWebView2Profile will match those specified options. + /// Otherwise if this CoreWebView2 was created without a CoreWebView2ControllerOptions, then + /// this will be the default CoreWebView2Profile for the corresponding CoreWebView2Environment. + /// + /// \snippet AppWindow.cpp CoreWebView2Profile + [propget] HRESULT Profile([out, retval] ICoreWebView2Profile** value); +} + +/// This interface is an extension of `ICoreWebView2_13` that adds +/// ServerCertificate support. +[uuid(6DAA4F10-4A90-4753-8898-77C5DF534165), object, pointer_default(unique)] +interface ICoreWebView2_14 : ICoreWebView2_13 { + /// Add an event handler for the ServerCertificateErrorDetected event. + /// The ServerCertificateErrorDetected event is raised when the WebView2 + /// cannot verify server's digital certificate while loading a web page. + /// + /// This event will raise for all web resources and follows the `WebResourceRequested` event. + /// + /// If you don't handle the event, WebView2 will show the default TLS interstitial error page to the user + /// for navigations, and for non-navigations the web request is cancelled. + /// + /// Note that WebView2 before raising `ServerCertificateErrorDetected` raises a `NavigationCompleted` event + /// with `IsSuccess` as FALSE and any of the below WebErrorStatuses that indicate a certificate failure. + /// + /// - COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_COMMON_NAME_IS_INCORRECT + /// - COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_EXPIRED + /// - COREWEBVIEW2_WEB_ERROR_STATUS_CLIENT_CERTIFICATE_CONTAINS_ERRORS + /// - COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_REVOKED + /// - COREWEBVIEW2_WEB_ERROR_STATUS_CERTIFICATE_IS_INVALID + /// + /// For more details see `ICoreWebView2NavigationCompletedEventArgs::get_IsSuccess` and handle + /// ServerCertificateErrorDetected event or show the default TLS interstitial error page to the user + /// according to the app needs. + /// + /// WebView2 caches the response when action is `COREWEBVIEW2_SERVER_CERTIFICATE_ERROR_ACTION_ALWAYS_ALLOW` + /// for the RequestUri's host and the server certificate in the session and the `ServerCertificateErrorDetected` + /// event won't be raised again. + /// + /// To raise the event again you must clear the cache using `ClearServerCertificateErrorActions`. + /// + /// \snippet SettingsComponent.cpp ServerCertificateErrorDetected1 + HRESULT add_ServerCertificateErrorDetected( + [in] ICoreWebView2ServerCertificateErrorDetectedEventHandler* + eventHandler, + [out] EventRegistrationToken* token); + /// Remove an event handler previously added with add_ServerCertificateErrorDetected. + HRESULT remove_ServerCertificateErrorDetected([in] EventRegistrationToken token); + + /// Clears all cached decisions to proceed with TLS certificate errors from the + /// ServerCertificateErrorDetected event for all WebView2's sharing the same session. + HRESULT ClearServerCertificateErrorActions( + [in] ICoreWebView2ClearServerCertificateErrorActionsCompletedHandler* + handler); +} + +/// Receives `StatusBarTextChanged` events. +[uuid(A5E3B0D0-10DF-4156-BFAD-3B43867ACAC6), object, pointer_default(unique)] +interface ICoreWebView2StatusBarTextChangedEventHandler : IUnknown { + /// Called to provide the implementer with the event args for the + /// corresponding event. No event args exist and the `args` + /// parameter is set to `null`. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] IUnknown* args); +} + +/// This interface is an extension of `ICoreWebView2_14` that supports status Favicons. +[uuid(517B2D1D-7DAE-4A66-A4F4-10352FFB9518), object, pointer_default(unique)] +interface ICoreWebView2_15 : ICoreWebView2_14 { + /// Add an event handler for the `FaviconChanged` event. + /// The `FaviconChanged` event is raised when the + /// [favicon](https://developer.mozilla.org/docs/Glossary/Favicon) + /// had a different URL then the previous URL. + /// The FaviconChanged event will be raised for first navigating to a new + /// document, whether or not a document declares a Favicon in HTML if the + /// favicon is different from the previous fav icon. The event will + /// be raised again if a favicon is declared in its HTML or has script + /// to set its favicon. The favicon information can then be retrieved with + /// `GetFavicon` and `FaviconUri`. + HRESULT add_FaviconChanged( + [in] ICoreWebView2FaviconChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove the event handler for `FaviconChanged` event. + HRESULT remove_FaviconChanged( + [in] EventRegistrationToken token); + + /// Get the current Uri of the favicon as a string. + /// If the value is null, then the return value is `E_POINTER`, otherwise it is `S_OK`. + /// If a page has no favicon then the value is an empty string. + [propget] HRESULT FaviconUri([out, retval] LPWSTR* value); + + /// Async function for getting the actual image data of the favicon. + /// The image is copied to the `imageStream` object in `ICoreWebView2GetFaviconCompletedHandler`. + /// If there is no image then no data would be copied into the imageStream. + /// The `format` is the file format to return the image stream. + /// `completedHandler` is executed at the end of the operation. + /// + /// \snippet SettingsComponent.cpp FaviconChanged + HRESULT GetFavicon( + [in] COREWEBVIEW2_FAVICON_IMAGE_FORMAT format, + [in] ICoreWebView2GetFaviconCompletedHandler* completedHandler); +} + +/// A continuation of the `ICoreWebView2` interface to support printing. +[uuid(0EB34DC9-9F91-41E1-8639-95CD5943906B), object, pointer_default(unique)] +interface ICoreWebView2_16 : ICoreWebView2_15 { + /// Print the current web page asynchronously to the specified printer with the provided settings. + /// See `ICoreWebView2PrintSettings` for description of settings. Passing + /// nullptr for `printSettings` results in default print settings used. + /// + /// The handler will return `errorCode` as `S_OK` and `printStatus` as COREWEBVIEW2_PRINT_STATUS_PRINTER_UNAVAILABLE + /// if `printerName` doesn't match with the name of any installed printers on the user OS. The handler + /// will return `errorCode` as `E_INVALIDARG` and `printStatus` as COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR + /// if the caller provides invalid settings for a given printer. + /// + /// The async `Print` operation completes when it finishes printing to the printer. + /// At this time the `ICoreWebView2PrintCompletedHandler` is invoked. + /// Only one `Printing` operation can be in progress at a time. If `Print` is called while a `Print` or `PrintToPdf` + /// or `PrintToPdfStream` or `ShowPrintUI` job is in progress, the completed handler is immediately invoked + /// with `E_ABORT` and `printStatus` is COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR. + /// This is only for printing operation on one webview. + /// + /// | errorCode | printStatus | Notes | + /// | --- | --- | --- | + /// | S_OK | COREWEBVIEW2_PRINT_STATUS_SUCCEEDED | Print operation succeeded. | + /// | S_OK | COREWEBVIEW2_PRINT_STATUS_PRINTER_UNAVAILABLE | If specified printer is not found or printer status is not available, offline or error state. | + /// | S_OK | COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR | Print operation is failed. | + /// | E_INVALIDARG | COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR | If the caller provides invalid settings for the specified printer. | + /// | E_ABORT | COREWEBVIEW2_PRINT_STATUS_OTHER_ERROR | Print operation is failed as printing job already in progress. | + /// + /// \snippet AppWindow.cpp PrintToPrinter + HRESULT Print( + [in] ICoreWebView2PrintSettings* printSettings, + [in] ICoreWebView2PrintCompletedHandler* handler); + + /// Opens the print dialog to print the current web page. See `COREWEBVIEW2_PRINT_DIALOG_KIND` + /// for descriptions of print dialog kinds. + /// + /// Invoking browser or system print dialog doesn't open new print dialog if + /// it is already open. + /// + /// \snippet AppWindow.cpp ShowPrintUI + HRESULT ShowPrintUI([in] COREWEBVIEW2_PRINT_DIALOG_KIND printDialogKind); + + /// Provides the Pdf data of current web page asynchronously for the provided settings. + /// Stream will be rewound to the start of the pdf data. + /// + /// See `ICoreWebView2PrintSettings` for description of settings. Passing + /// nullptr for `printSettings` results in default print settings used. + /// + /// The async `PrintToPdfStream` operation completes when it finishes + /// writing to the stream. At this time the `ICoreWebView2PrintToPdfStreamCompletedHandler` + /// is invoked. Only one `Printing` operation can be in progress at a time. If + /// `PrintToPdfStream` is called while a `PrintToPdfStream` or `PrintToPdf` or `Print` + /// or `ShowPrintUI` job is in progress, the completed handler is immediately invoked with `E_ABORT`. + /// This is only for printing operation on one webview. + /// + /// \snippet AppWindow.cpp PrintToPdfStream + HRESULT PrintToPdfStream([in] ICoreWebView2PrintSettings* printSettings, + [in] ICoreWebView2PrintToPdfStreamCompletedHandler* handler); +} + +/// Receives the result of the `Print` method. +[uuid(8FD80075-ED08-42DB-8570-F5D14977461E), object, pointer_default(unique)] +interface ICoreWebView2PrintCompletedHandler : IUnknown { + /// Provides the result of the corresponding asynchronous method. + HRESULT Invoke([in] HRESULT errorCode, [in] COREWEBVIEW2_PRINT_STATUS printStatus); +} + +/// This interface is an extension of `ICoreWebView2_16` that supports shared buffer based on file mapping. +[uuid(702E75D4-FD44-434D-9D70-1A68A6B1192A), object, pointer_default(unique)] +interface ICoreWebView2_17 : ICoreWebView2_16 { + /// Share a shared buffer object with script of the main frame in the WebView. + /// The script will receive a `sharedbufferreceived` event from chrome.webview. + /// The event arg for that event will have the following methods and properties: + /// `getBuffer()`: return an ArrayBuffer object with the backing content from the shared buffer. + /// `additionalData`: an object as the result of parsing `additionalDataAsJson` as JSON string. + /// This property will be `undefined` if `additionalDataAsJson` is nullptr or empty string. + /// `source`: with a value set as `chrome.webview` object. + /// If a string is provided as `additionalDataAsJson` but it is not a valid JSON string, + /// the API will fail with `E_INVALIDARG`. + /// If `access` is COREWEBVIEW2_SHARED_BUFFER_ACCESS_READ_ONLY, the script will only have read access to the buffer. + /// If the script tries to modify the content in a read only buffer, it will cause an access + /// violation in WebView renderer process and crash the renderer process. + /// If the shared buffer is already closed, the API will fail with `RO_E_CLOSED`. + /// + /// The script code should call `chrome.webview.releaseBuffer` with + /// the shared buffer as the parameter to release underlying resources as soon + /// as it does not need access to the shared buffer any more. + /// + /// The application can post the same shared buffer object to multiple web pages or iframes, or + /// post to the same web page or iframe multiple times. Each `PostSharedBufferToScript` will + /// create a separate ArrayBuffer object with its own view of the memory and is separately + /// released. The underlying shared memory will be released when all the views are released. + /// + /// For example, if we want to send data to script for one time read only consumption. + /// + /// \snippet ScenarioSharedBuffer.cpp OneTimeShareBuffer + /// + /// In the HTML document, + /// + /// \snippet assets\ScenarioSharedBuffer.html ShareBufferScriptCode_1 + /// + /// \snippet assets\ScenarioSharedBuffer.html ShareBufferScriptCode_2 + /// + /// Sharing a buffer to script has security risk. You should only share buffer with trusted site. + /// If a buffer is shared to a untrusted site, possible sensitive information could be leaked. + /// If a buffer is shared as modifiable by the script and the script modifies it in an unexpected way, + /// it could result in corrupted data that might even crash the application. + /// + HRESULT PostSharedBufferToScript( + [in] ICoreWebView2SharedBuffer* sharedBuffer, + [in] COREWEBVIEW2_SHARED_BUFFER_ACCESS access, + [in] LPCWSTR additionalDataAsJson); +} + +/// Receives the result of the `PrintToPdfStream` method. +/// `errorCode` returns S_OK if the PrintToPdfStream operation succeeded. +/// The printable pdf data is returned in the `pdfStream` object. +[uuid(4C9F8229-8F93-444F-A711-2C0DFD6359D5), object, pointer_default(unique)] +interface ICoreWebView2PrintToPdfStreamCompletedHandler : IUnknown { + /// Provides the result of the corresponding asynchronous method. + HRESULT Invoke([in] HRESULT errorCode, [in] IStream* pdfStream); +} + +/// Settings used by the `Print` method. +[uuid(CA7F0E1F-3484-41D1-8C1A-65CD44A63F8D), object, pointer_default(unique)] +interface ICoreWebView2PrintSettings2 : ICoreWebView2PrintSettings { + /// Page range to print. Defaults to empty string, which means print all pages. + /// If the Page range is empty string or null, then it applies the default. + /// + /// The PageRanges property is a list of page ranges specifying one or more pages that + /// should be printed separated by commas. Any whitespace between page ranges is ignored. + /// A valid page range is either a single integer identifying the page to print, or a range + /// in the form `[start page]-[last page]` where `start page` and `last page` are integers + /// identifying the first and last inclusive pages respectively to print. + /// Every page identifier is an integer greater than 0 unless wildcards are used (see below examples). + /// The first page is 1. + /// + /// In a page range of the form `[start page]-[last page]` the start page number must be + /// larger than 0 and less than or equal to the document's total page count. + /// If the `start page` is not present, then 1 is used as the `start page`. + /// The `last page` must be larger than the `start page`. + /// If the `last page` is not present, then the document total page count is used as the `last page`. + /// + /// Repeating a page does not print it multiple times. To print multiple times, use the `Copies` property. + /// + /// The pages are always printed in ascending order, even if specified in non-ascending order. + /// + /// If page range is not valid or if a page is greater than document total page count, + /// `ICoreWebView2PrintCompletedHandler` or `ICoreWebView2PrintToPdfStreamCompletedHandler` + /// handler will return `E_INVALIDARG`. + /// + /// The following examples assume a document with 20 total pages. + /// + /// | Example | Result | Notes | + /// | --- | --- | --- | + /// | "2" | Page 2 | | + /// | "1-4, 9, 3-6, 10, 11" | Pages 1-6, 9-11 | | + /// | "1-4, -6" | Pages 1-6 | The "-6" is interpreted as "1-6". | + /// | "2-" | Pages 2-20 | The "2-" is interpreted as "pages 2 to the end of the document". | + /// | "4-2, 11, -6" | Invalid | "4-2" is an invalid range. | + /// | "-" | Pages 1-20 | The "-" is interpreted as "page 1 to the end of the document". | + /// | "1-4dsf, 11" | Invalid | | + /// | "2-2" | Page 2 | | + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings) + [propget] HRESULT PageRanges([out, retval] LPWSTR* value); + + /// Set the `PageRanges` property. + [propput] HRESULT PageRanges([in] LPCWSTR value); + + /// Prints multiple pages of a document on a single piece of paper. Choose from 1, 2, 4, 6, 9 or 16. + /// The default value is 1. + [propget] HRESULT PagesPerSide([out, retval] INT32* value); + + /// Set the `PagesPerSide` property. Returns `E_INVALIDARG` if an invalid value is + /// provided, and the current value is not changed. + /// + /// Below examples shows print output for PagesPerSide and Duplex. + /// + /// | PagesPerSide | Total pages | Two-sided printing | Result | + /// | --- | --- | --- | --- | + /// | 1 | 1 | - | 1 page on the front side. | + /// | 2 | 1 | Yes | 1 page on the front side. | + /// | 2 | 4 | - | 2 pages on the first paper and 2 pages on the next paper. | + /// | 2 | 4 | Yes | 2 pages on the front side and 2 pages on back side. | + /// | 4 | 4 | Yes | 4 pages on the front side. | + /// | 4 | 8 | Yes | 4 pages on the front side and 4 pages on the back side. | + [propput] HRESULT PagesPerSide([in] INT32 value); + + /// Number of copies to print. Minimum value is `1` and the maximum copies count is `999`. + /// The default value is 1. + /// + /// This value is ignored in PrintToPdfStream method. + [propget] HRESULT Copies([out, retval] INT32* value); + + /// Set the `Copies` property. Returns `E_INVALIDARG` if an invalid value is provided + /// and the current value is not changed. + [propput] HRESULT Copies([in] INT32 value); + + /// Printer collation. See `COREWEBVIEW2_PRINT_COLLATION` for descriptions of + /// collation. The default value is `COREWEBVIEW2_PRINT_COLLATION_DEFAULT`. + /// + /// Printing uses default value of printer's collation if an invalid value is provided + /// for the specific printer. + /// + /// This value is ignored in PrintToPdfStream method. + [propget] HRESULT Collation([out, retval] COREWEBVIEW2_PRINT_COLLATION* value); + + /// Set the `Collation` property. + [propput] HRESULT Collation([in] COREWEBVIEW2_PRINT_COLLATION value); + + /// Printer color mode. See `COREWEBVIEW2_PRINT_COLOR_MODE` for descriptions + /// of color modes. The default value is `COREWEBVIEW2_PRINT_COLOR_MODE_DEFAULT`. + /// + /// Printing uses default value of printer supported color if an invalid value is provided + /// for the specific printer. + [propget] HRESULT ColorMode([out, retval] COREWEBVIEW2_PRINT_COLOR_MODE* value); + + /// Set the `ColorMode` property. + [propput] HRESULT ColorMode([in] COREWEBVIEW2_PRINT_COLOR_MODE value); + + /// Printer duplex settings. See `COREWEBVIEW2_PRINT_DUPLEX` for descriptions of duplex. + /// The default value is `COREWEBVIEW2_PRINT_DUPLEX_DEFAULT`. + /// + /// Printing uses default value of printer's duplex if an invalid value is provided + /// for the specific printer. + /// + /// This value is ignored in PrintToPdfStream method. + [propget] HRESULT Duplex([out, retval] COREWEBVIEW2_PRINT_DUPLEX* value); + + /// Set the `Duplex` property. + [propput] HRESULT Duplex([in] COREWEBVIEW2_PRINT_DUPLEX value); + + /// Printer media size. See `COREWEBVIEW2_PRINT_MEDIA_SIZE` for descriptions of media size. + /// The default value is `COREWEBVIEW2_PRINT_MEDIA_SIZE_DEFAULT`. + /// + /// If media size is `COREWEBVIEW2_PRINT_MEDIA_SIZE_CUSTOM`, you should set the `PageWidth` + /// and `PageHeight`. + /// + /// Printing uses default value of printer supported media size if an invalid value is provided + /// for the specific printer. + /// + /// This value is ignored in PrintToPdfStream method. + [propget] HRESULT MediaSize([out, retval] COREWEBVIEW2_PRINT_MEDIA_SIZE* value); + + /// Set the `MediaSize` property. + [propput] HRESULT MediaSize([in] COREWEBVIEW2_PRINT_MEDIA_SIZE value); + + /// The name of the printer to use. Defaults to empty string. + /// If the printer name is empty string or null, then it prints to the default + /// printer on the user OS. + /// + /// This value is ignored in PrintToPdfStream method. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings) + [propget] HRESULT PrinterName([out, retval] LPWSTR* value); + + /// Set the `PrinterName` property. If provided printer name doesn't match + /// with the name of any installed printers on the user OS, + /// `ICoreWebView2PrintCompletedHandler` handler will return `errorCode` as + /// `S_OK` and `printStatus` as COREWEBVIEW2_PRINT_STATUS_PRINTER_UNAVAILABLE. + /// + /// Use [Enum Printers](/windows/win32/printdocs/enumprinters) + /// to enumerate available printers. + [propput] HRESULT PrinterName([in] LPCWSTR value); +} + +/// This interface is an extension of `ICoreWebView2_17` that manages +/// navigation requests to URI schemes registered with the OS. +[uuid(7A626017-28BE-49B2-B865-3BA2B3522D90), object, pointer_default(unique)] +interface ICoreWebView2_18 : ICoreWebView2_17 { + /// Add an event handler for the `LaunchingExternalUriScheme` event. + /// The `LaunchingExternalUriScheme` event is raised when a navigation request is made to + /// a URI scheme that is registered with the OS. + /// The `LaunchingExternalUriScheme` event handler may suppress the default dialog + /// or replace the default dialog with a custom dialog. + /// + /// If a deferral is not taken on the event args, the external URI scheme launch is + /// blocked until the event handler returns. If a deferral is taken, the + /// external URI scheme launch is blocked until the deferral is completed. + /// The host also has the option to cancel the URI scheme launch. + /// + /// The `NavigationStarting` and `NavigationCompleted` events will be raised, + /// regardless of whether the `Cancel` property is set to `TRUE` or + /// `FALSE`. The `NavigationCompleted` event will be raised with the `IsSuccess` property + /// set to `FALSE` and the `WebErrorStatus` property set to `ConnectionAborted` regardless of + /// whether the host sets the `Cancel` property on the + /// `ICoreWebView2LaunchingExternalUriSchemeEventArgs`. The `SourceChanged`, `ContentLoading`, + /// and `HistoryChanged` events will not be raised for this navigation to the external URI + /// scheme regardless of the `Cancel` property. + /// The `LaunchingExternalUriScheme` event will be raised after the + /// `NavigationStarting` event and before the `NavigationCompleted` event. + /// The default `CoreWebView2Settings` will also be updated upon navigation to an external + /// URI scheme. If a setting on the `CoreWebView2Settings` interface has been changed, + /// navigating to an external URI scheme will trigger the `CoreWebView2Settings` to update. + /// + /// The WebView2 may not display the default dialog based on user settings, browser settings, + /// and whether the origin is determined as a + /// [trustworthy origin](https://w3c.github.io/webappsec-secure-contexts# + /// potentially-trustworthy-origin); however, the event will still be raised. + /// + /// If the request is initiated by a cross-origin frame without a user gesture, + /// the request will be blocked and the `LaunchingExternalUriScheme` event will not + /// be raised. + /// \snippet SettingsComponent.cpp ToggleLaunchingExternalUriScheme + HRESULT add_LaunchingExternalUriScheme( + [in] ICoreWebView2LaunchingExternalUriSchemeEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_LaunchingExternalUriScheme`. + HRESULT remove_LaunchingExternalUriScheme( + [in] EventRegistrationToken token); +} + +/// This interface is an extension of `ICoreWebView2_18` that manages memory usage +/// target level. +[uuid(6921F954-79B0-437F-A997-C85811897C68), object, pointer_default(unique)] +interface ICoreWebView2_19 : ICoreWebView2_18 { + + /// `MemoryUsageTargetLevel` indicates desired memory consumption level of + /// WebView. + [propget] HRESULT MemoryUsageTargetLevel( + [out, retval] COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL* level); + + /// An app may set `MemoryUsageTargetLevel` to indicate desired memory + /// consumption level of WebView. Scripts will not be impacted and continue + /// to run. This is useful for inactive apps that still want to run scripts + /// and/or keep network connections alive and therefore could not call + /// `TrySuspend` and `Resume` to reduce memory consumption. These apps can + /// set memory usage target level to `COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_LOW` + /// when the app becomes inactive, and set back to + /// `COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_NORMAL` when the app becomes + /// active. It is not necessary to set CoreWebView2Controller's IsVisible + /// property to false when setting the property. + /// It is a best effort operation to change memory usage level, and the + /// API will return before the operation completes. + /// Setting the level to `COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_LOW` + /// could potentially cause memory for some WebView browser processes to be + /// swapped out to disk in some circumstances. + /// It is a best effort to reduce memory usage as much as possible. If a script + /// runs after its related memory has been swapped out, the memory will be swapped + /// back in to ensure the script can still run, but performance might be impacted. + /// Therefore, the app should set the level back to + /// `COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL_NORMAL` when the app becomes + /// active again. Setting memory usage target level back to normal will not happen + /// automatically. + /// An app should choose to use either the combination of `TrySuspend` and `Resume` + /// or the combination of setting MemoryUsageTargetLevel to low and normal. It is + /// not advisable to mix them. + /// Trying to set `MemoryUsageTargetLevel` while suspended will be ignored. + /// The `TrySuspend` and `Resume` methods will change the `MemoryUsageTargetLevel`. + /// `TrySuspend` will automatically set `MemoryUsageTargetLevel` to low while + /// `Resume` on suspended WebView will automatically set `MemoryUsageTargetLevel` + /// to normal. Calling `Resume` when the WebView is not suspended would not change + /// `MemoryUsageTargetLevel`. + /// + /// \snippet ViewComponent.cpp MemoryUsageTargetLevel + [propput] HRESULT MemoryUsageTargetLevel( + [in] COREWEBVIEW2_MEMORY_USAGE_TARGET_LEVEL level); + +} + +/// Event handler for the `LaunchingExternalUriScheme` event. +[uuid(74F712E0-8165-43A9-A13F-0CCE597E75DF), object, pointer_default(unique)] +interface ICoreWebView2LaunchingExternalUriSchemeEventHandler: IUnknown { + /// Receives the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2LaunchingExternalUriSchemeEventArgs* args); +} + +/// Event args for `LaunchingExternalUriScheme` event. +[uuid(07D1A6C3-7175-4BA1-9306-E593CA07E46C), object, pointer_default(unique)] +interface ICoreWebView2LaunchingExternalUriSchemeEventArgs: IUnknown { + /// The URI with the external URI scheme to be launched. + + [propget] HRESULT Uri([out, retval] LPWSTR* value); + + /// The origin initiating the external URI scheme launch. + /// The origin will be an empty string if the request is initiated by calling + /// `CoreWebView2.Navigate` on the external URI scheme. If a script initiates + /// the navigation, the `InitiatingOrigin` will be the top-level document's + /// `Source`, for example, if `window.location` is set to `"calculator://", the + /// `InitiatingOrigin` will be set to `calculator://`. If the request is initiated + /// from a child frame, the `InitiatingOrigin` will be the source of that child frame. + + [propget] HRESULT InitiatingOrigin([out, retval] LPWSTR* value); + + /// `TRUE` when the external URI scheme request was initiated through a user gesture. + /// + /// \> [!NOTE]\n\> Being initiated through a user gesture does not mean that user intended + /// to access the associated resource. + + [propget] HRESULT IsUserInitiated([out, retval] BOOL* value); + + /// The event handler may set this property to `TRUE` to cancel the external URI scheme + /// launch. If set to `TRUE`, the external URI scheme will not be launched, and the default + /// dialog is not displayed. This property can be used to replace the normal + /// handling of launching an external URI scheme. + /// The initial value of the `Cancel` property is `FALSE`. + + [propget] HRESULT Cancel([out, retval] BOOL* value); + + /// Sets the `Cancel` property. + + [propput] HRESULT Cancel([in] BOOL value); + + /// Returns an `ICoreWebView2Deferral` object. Use this operation to + /// complete the event at a later time. + + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** value); +} + +/// The caller implements this interface to handle the BasicAuthenticationRequested event. +[uuid(58b4d6c2-18d4-497e-b39b-9a96533fa278), object, pointer_default(unique)] +interface ICoreWebView2BasicAuthenticationRequestedEventHandler : IUnknown { + /// Called to provide the implementer with the event args for the + /// corresponding event. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2BasicAuthenticationRequestedEventArgs* args); +} + +/// Implements the interface to receive `IsDefaultDownloadDialogOpenChanged` +/// events. +[uuid(3117da26-ae13-438d-bd46-edbeb2c4ce81), object, pointer_default(unique)] +interface ICoreWebView2IsDefaultDownloadDialogOpenChangedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + HRESULT Invoke([in] ICoreWebView2* sender, + [in] IUnknown* args); +} + +/// Receives the result of the `PrintToPdf` method. If the print to PDF +/// operation succeeds, `isSuccessful` is true. Otherwise, if the operation +/// failed, `isSuccessful` is set to false. An invalid path returns +/// `E_INVALIDARG`. +[uuid(ccf1ef04-fd8e-4d5f-b2de-0983e41b8c36), object, pointer_default(unique)] +interface ICoreWebView2PrintToPdfCompletedHandler : IUnknown { + + /// Provides the result of the corresponding asynchronous method. + HRESULT Invoke([in] HRESULT errorCode, BOOL isSuccessful); +} + +/// Settings used by the `PrintToPdf` method. +[uuid(377f3721-c74e-48ca-8db1-df68e51d60e2), object, pointer_default(unique)] +interface ICoreWebView2PrintSettings : IUnknown { + + /// The orientation can be portrait or landscape. The default orientation is + /// portrait. See `COREWEBVIEW2_PRINT_ORIENTATION`. + [propget] HRESULT Orientation( + [out, retval] COREWEBVIEW2_PRINT_ORIENTATION* orientation); + + /// Sets the `Orientation` property. + [propput] HRESULT Orientation( + [in] COREWEBVIEW2_PRINT_ORIENTATION orientation); + + /// The scale factor is a value between 0.1 and 2.0. The default is 1.0. + [propget] HRESULT ScaleFactor([out, retval] double* scaleFactor); + + /// Sets the `ScaleFactor` property. Returns `E_INVALIDARG` if an invalid + /// value is provided, and the current value is not changed. + [propput] HRESULT ScaleFactor([in] double scaleFactor); + + /// The page width in inches. The default width is 8.5 inches. + [propget] HRESULT PageWidth([out, retval] double* pageWidth); + + /// Sets the `PageWidth` property. Returns `E_INVALIDARG` if the page width is + /// less than or equal to zero, and the current value is not changed. + [propput] HRESULT PageWidth([in] double pageWidth); + + /// The page height in inches. The default height is 11 inches. + [propget] HRESULT PageHeight([out, retval] double* pageHeight); + + /// Sets the `PageHeight` property. Returns `E_INVALIDARG` if the page height + /// is less than or equal to zero, and the current value is not changed. + [propput] HRESULT PageHeight([in] double pageHeight); + + /// The top margin in inches. The default is 1 cm, or ~0.4 inches. + [propget] HRESULT MarginTop([out, retval] double* marginTop); + + /// Sets the `MarginTop` property. A margin cannot be less than zero. + /// Returns `E_INVALIDARG` if an invalid value is provided, and the current + /// value is not changed. + [propput] HRESULT MarginTop([in] double marginTop); + + /// The bottom margin in inches. The default is 1 cm, or ~0.4 inches. + [propget] HRESULT MarginBottom([out, retval] double* marginBottom); + + /// Sets the `MarginBottom` property. A margin cannot be less than zero. + /// Returns `E_INVALIDARG` if an invalid value is provided, and the current + /// value is not changed. + [propput] HRESULT MarginBottom([in] double marginBottom); + + /// The left margin in inches. The default is 1 cm, or ~0.4 inches. + [propget] HRESULT MarginLeft([out, retval] double* marginLeft); + + /// Sets the `MarginLeft` property. A margin cannot be less than zero. + /// Returns `E_INVALIDARG` if an invalid value is provided, and the current + /// value is not changed. + [propput] HRESULT MarginLeft([in] double marginLeft); + + /// The right margin in inches. The default is 1 cm, or ~0.4 inches. + [propget] HRESULT MarginRight([out, retval] double* marginRight); + + /// Set the `MarginRight` property.A margin cannot be less than zero. + /// Returns `E_INVALIDARG` if an invalid value is provided, and the current + /// value is not changed. + [propput] HRESULT MarginRight([in] double marginRight); + + /// `TRUE` if background colors and images should be printed. The default value + /// is `FALSE`. + [propget] HRESULT ShouldPrintBackgrounds( + [out, retval] BOOL* shouldPrintBackgrounds); + + /// Set the `ShouldPrintBackgrounds` property. + [propput] HRESULT ShouldPrintBackgrounds([in] BOOL shouldPrintBackgrounds); + + /// `TRUE` if only the current end user's selection of HTML in the document + /// should be printed. The default value is `FALSE`. + [propget] HRESULT ShouldPrintSelectionOnly( + [out, retval] BOOL* shouldPrintSelectionOnly); + + /// Set the `ShouldPrintSelectionOnly` property. + [propput] HRESULT ShouldPrintSelectionOnly( + [in] BOOL shouldPrintSelectionOnly); + + /// `TRUE` if header and footer should be printed. The default value is `FALSE`. + /// The header consists of the date and time of printing, and the title of the + /// page. The footer consists of the URI and page number. The height of the + /// header and footer is 0.5 cm, or ~0.2 inches. + [propget] HRESULT ShouldPrintHeaderAndFooter( + [out, retval] BOOL* shouldPrintHeaderAndFooter); + + /// Set the `ShouldPrintHeaderAndFooter` property. + [propput] HRESULT ShouldPrintHeaderAndFooter( + [in] BOOL shouldPrintHeaderAndFooter); + + /// The title in the header if `ShouldPrintHeaderAndFooter` is `TRUE`. The + /// default value is the title of the current document. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT HeaderTitle([out, retval] LPWSTR* headerTitle); + + /// Set the `HeaderTitle` property. If an empty string or null value is + /// provided, no title is shown in the header. + [propput] HRESULT HeaderTitle([in] LPCWSTR headerTitle); + + /// The URI in the footer if `ShouldPrintHeaderAndFooter` is `TRUE`. The + /// default value is the current URI. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT FooterUri([out, retval] LPWSTR* footerUri); + + /// Set the `FooterUri` property. If an empty string or null value is + /// provided, no URI is shown in the footer. + [propput] HRESULT FooterUri([in] LPCWSTR footerUri); +} + +/// The caller implements this interface to receive the TrySuspend result. +[uuid(00F206A7-9D17-4605-91F6-4E8E4DE192E3), object, pointer_default(unique)] +interface ICoreWebView2TrySuspendCompletedHandler : IUnknown { + + /// Provides the result of the TrySuspend operation. + /// See [Sleeping Tabs FAQ](https://techcommunity.microsoft.com/t5/articles/sleeping-tabs-faq/m-p/1705434) + /// for conditions that might prevent WebView from being suspended. In those situations, + /// isSuccessful will be false and errorCode is S_OK. + HRESULT Invoke([in] HRESULT errorCode, [in] BOOL isSuccessful); + +} + +/// The owner of the `CoreWebView2` object that provides support for resizing, +/// showing and hiding, focusing, and other functionality related to +/// windowing and composition. The `CoreWebView2Controller` owns the +/// `CoreWebView2`, and if all references to the `CoreWebView2Controller` go +/// away, the WebView is closed. +[uuid(4d00c0d1-9434-4eb6-8078-8697a560334f), object, pointer_default(unique)] +interface ICoreWebView2Controller : IUnknown { + + /// The `IsVisible` property determines whether to show or hide the WebView2. + /// If `IsVisible` is set to `FALSE`, the WebView2 is transparent and is + /// not rendered. However, this does not affect the window containing the + /// WebView2 (the `HWND` parameter that was passed to + /// `CreateCoreWebView2Controller`). If you want that window to disappear + /// too, run `ShowWindow` on it directly in addition to modifying the + /// `IsVisible` property. WebView2 as a child window does not get window + /// messages when the top window is minimized or restored. For performance + /// reasons, developers should set the `IsVisible` property of the WebView to + /// `FALSE` when the app window is minimized and back to `TRUE` when the app + /// window is restored. The app window does this by handling + /// `SIZE_MINIMIZED and SIZE_RESTORED` command upon receiving `WM_SIZE` + /// message. + /// + /// There are CPU and memory benefits when the page is hidden. For instance, + /// Chromium has code that throttles activities on the page like animations + /// and some tasks are run less frequently. Similarly, WebView2 will + /// purge some caches to reduce memory usage. + /// + /// \snippet ViewComponent.cpp ToggleIsVisible + [propget] HRESULT IsVisible([out, retval] BOOL* isVisible); + + /// Sets the `IsVisible` property. + /// + /// \snippet ViewComponent.cpp ToggleIsVisibleOnMinimize + [propput] HRESULT IsVisible([in] BOOL isVisible); + + /// The WebView bounds. Bounds are relative to the parent `HWND`. The app + /// has two ways to position a WebView. + /// + /// * Create a child `HWND` that is the WebView parent `HWND`. Position + /// the window where the WebView should be. Use `(0, 0)` for the + /// top-left corner (the offset) of the `Bounds` of the WebView. + /// * Use the top-most window of the app as the WebView parent HWND. For + /// example, to position WebView correctly in the app, set the top-left + /// corner of the Bound of the WebView. + /// + /// The values of `Bounds` are limited by the coordinate space of the host. + + [propget] HRESULT Bounds([out, retval] RECT* bounds); + + /// Sets the `Bounds` property. + /// + /// \snippet ViewComponent.cpp ResizeWebView + + [propput] HRESULT Bounds([in] RECT bounds); + + /// The zoom factor for the WebView. + /// + /// \> [!NOTE]\n\> Changing zoom factor may cause `window.innerWidth`, + /// `window.innerHeight`, both, and page layout to change. A zoom factor + /// that is applied by the host by running `ZoomFactor` becomes the new + /// default zoom for the WebView. The zoom factor applies across navigations + /// and is the zoom factor WebView is returned to when the user chooses + /// Ctrl+0. When the zoom factor is changed by the user (resulting in + /// the app receiving `ZoomFactorChanged`), that zoom applies only for the + /// current page. Any user applied zoom is only for the current page and is + /// reset on a navigation. Specifying a `zoomFactor` less than or equal to + /// `0` is not allowed. WebView also has an internal supported zoom factor + /// range. When a specified zoom factor is out of that range, it is + /// normalized to be within the range, and a `ZoomFactorChanged` event is + /// triggered for the real applied zoom factor. When the range normalization + /// happens, the `ZoomFactor` property reports the zoom factor specified + /// during the previous modification of the `ZoomFactor` property until the + /// `ZoomFactorChanged` event is received after WebView applies the + /// normalized zoom factor. + + [propget] HRESULT ZoomFactor([out, retval] double* zoomFactor); + + /// Sets the `ZoomFactor` property. + + [propput] HRESULT ZoomFactor([in] double zoomFactor); + + /// Adds an event handler for the `ZoomFactorChanged` event. + /// `ZoomFactorChanged` runs when the `ZoomFactor` property of the WebView + /// changes. The event may run because the `ZoomFactor` property was + /// modified, or due to the user manually modifying the zoom. When it is + /// modified using the `ZoomFactor` property, the internal zoom factor is + /// updated immediately and no `ZoomFactorChanged` event is triggered. + /// WebView associates the last used zoom factor for each site. It is + /// possible for the zoom factor to change when navigating to a different + /// page. When the zoom factor changes due to a navigation change, the + /// `ZoomFactorChanged` event runs right after the `ContentLoading` event. + /// + /// \snippet ViewComponent.cpp ZoomFactorChanged + + HRESULT add_ZoomFactorChanged( + [in] ICoreWebView2ZoomFactorChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ZoomFactorChanged`. + + HRESULT remove_ZoomFactorChanged( + [in] EventRegistrationToken token); + + /// Updates `Bounds` and `ZoomFactor` properties at the same time. This + /// operation is atomic from the perspective of the host. After returning + /// from this function, the `Bounds` and `ZoomFactor` properties are both + /// updated if the function is successful, or neither is updated if the + /// function fails. If `Bounds` and `ZoomFactor` are both updated by the + /// same scale (for example, `Bounds` and `ZoomFactor` are both doubled), + /// then the page does not display a change in `window.innerWidth` or + /// `window.innerHeight` and the WebView renders the content at the new size + /// and zoom without intermediate renderings. This function also updates + /// just one of `ZoomFactor` or `Bounds` by passing in the new value for one + /// and the current value for the other. + /// + /// \snippet ViewComponent.cpp SetBoundsAndZoomFactor + + HRESULT SetBoundsAndZoomFactor([in] RECT bounds, [in] double zoomFactor); + + /// Moves focus into WebView. WebView gets focus and focus is set to + /// correspondent element in the page hosted in the WebView. For + /// Programmatic reason, focus is set to previously focused element or the + /// default element if no previously focused element exists. For `Next` + /// reason, focus is set to the first element. For `Previous` reason, focus + /// is set to the last element. WebView changes focus through user + /// interaction including selecting into a WebView or Tab into it. For + /// tabbing, the app runs MoveFocus with Next or Previous to align with Tab + /// and Shift+Tab respectively when it decides the WebView is the next + /// element that may exist in a tab. Or, the app runs `IsDialogMessage` + /// as part of the associated message loop to allow the platform to auto + /// handle tabbing. The platform rotates through all windows with + /// `WS_TABSTOP`. When the WebView gets focus from `IsDialogMessage`, it is + /// internally put the focus on the first or last element for tab and + /// Shift+Tab respectively. + /// + /// \snippet App.cpp MoveFocus0 + /// + /// \snippet ControlComponent.cpp MoveFocus1 + /// + /// \snippet ControlComponent.cpp MoveFocus2 + + HRESULT MoveFocus([in] COREWEBVIEW2_MOVE_FOCUS_REASON reason); + + /// Adds an event handler for the `MoveFocusRequested` event. + /// `MoveFocusRequested` runs when user tries to tab out of the WebView. The + /// focus of the WebView has not changed when this event is run. + /// + /// \snippet ControlComponent.cpp MoveFocusRequested + + HRESULT add_MoveFocusRequested( + [in] ICoreWebView2MoveFocusRequestedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Removes an event handler previously added with `add_MoveFocusRequested`. + + HRESULT remove_MoveFocusRequested( + [in] EventRegistrationToken token); + + /// Adds an event handler for the `GotFocus` event. `GotFocus` runs when + /// WebView has focus. + + HRESULT add_GotFocus( + [in] ICoreWebView2FocusChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Removes an event handler previously added with `add_GotFocus`. + + HRESULT remove_GotFocus( + [in] EventRegistrationToken token); + + /// Adds an event handler for the `LostFocus` event. `LostFocus` runs when + /// WebView loses focus. In the case where `MoveFocusRequested` event is + /// run, the focus is still on WebView when `MoveFocusRequested` event runs. + /// `LostFocus` only runs afterwards when code of the app or default action + /// of `MoveFocusRequested` event set focus away from WebView. + + HRESULT add_LostFocus( + [in] ICoreWebView2FocusChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Removes an event handler previously added with `add_LostFocus`. + + HRESULT remove_LostFocus( + [in] EventRegistrationToken token); + + /// Adds an event handler for the `AcceleratorKeyPressed` event. + /// `AcceleratorKeyPressed` runs when an accelerator key or key combo is + /// pressed or released while the WebView is focused. A key is considered an + /// accelerator if either of the following conditions are true. + /// + /// * Ctrl or Alt is currently being held. + /// * The pressed key does not map to a character. + /// + /// A few specific keys are never considered accelerators, such as Shift. + /// The `Escape` key is always considered an accelerator. + /// + /// Auto-repeated key events caused by holding the key down also triggers + /// this event. Filter out the auto-repeated key events by verifying the + /// `KeyEventLParam` or `PhysicalKeyStatus` event args. + /// + /// In windowed mode, the event handler is run synchronously. Until you + /// run `Handled()` on the event args or the event handler returns, the + /// browser process is blocked and outgoing cross-process COM requests fail + /// with `RPC_E_CANTCALLOUT_ININPUTSYNCCALL`. All `CoreWebView2` API methods + /// work, however. + /// + /// In windowless mode, the event handler is run asynchronously. Further + /// input do not reach the browser until the event handler returns or + /// `Handled()` is run, but the browser process is not blocked, and outgoing + /// COM requests work normally. + /// + /// It is recommended to run `Handled(TRUE)` as early as are able to know + /// that you want to handle the accelerator key. + /// + /// \snippet ControlComponent.cpp AcceleratorKeyPressed + + HRESULT add_AcceleratorKeyPressed( + [in] ICoreWebView2AcceleratorKeyPressedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Removes an event handler previously added with + /// `add_AcceleratorKeyPressed`. + + HRESULT remove_AcceleratorKeyPressed( + [in] EventRegistrationToken token); + + /// The parent window provided by the app that this WebView is using to + /// render content. This API initially returns the window passed into + /// `CreateCoreWebView2Controller`. + + [propget] HRESULT ParentWindow([out, retval] HWND* parentWindow); + + /// Sets the parent window for the WebView. This causes the WebView to + /// re-parent the main WebView window to the newly provided window. + + [propput] HRESULT ParentWindow([in] HWND parentWindow); + + /// This is a notification separate from `Bounds` that tells WebView that the + /// main WebView parent (or any ancestor) `HWND` moved. This is needed + /// for accessibility and certain dialogs in WebView to work correctly. + /// + /// \snippet ViewComponent.cpp NotifyParentWindowPositionChanged + + HRESULT NotifyParentWindowPositionChanged(); + + /// Closes the WebView and cleans up the underlying browser instance. + /// Cleaning up the browser instance releases the resources powering the + /// WebView. The browser instance is shut down if no other WebViews are + /// using it. + /// + /// After running `Close`, most methods will fail and event handlers stop + /// running. Specifically, the WebView releases the associated references to + /// any associated event handlers when `Close` is run. + /// + /// `Close` is implicitly run when the `CoreWebView2Controller` loses the + /// final reference and is destructed. But it is best practice to + /// explicitly run `Close` to avoid any accidental cycle of references + /// between the WebView and the app code. Specifically, if you capture a + /// reference to the WebView in an event handler you create a reference cycle + /// between the WebView and the event handler. Run `Close` to break the + /// cycle by releasing all event handlers. But to avoid the situation, it is + /// best to both explicitly run `Close` on the WebView and to not capture a + /// reference to the WebView to ensure the WebView is cleaned up correctly. + /// `Close` is synchronous and won't trigger the `beforeunload` event. + /// + /// \snippet AppWindow.cpp Close + HRESULT Close(); + + /// Gets the `CoreWebView2` associated with this `CoreWebView2Controller`. + + [propget] HRESULT CoreWebView2([out, retval] ICoreWebView2** coreWebView2); +} + +/// A continuation of the ICoreWebView2Controller interface. +[uuid(c979903e-d4ca-4228-92eb-47ee3fa96eab), object, pointer_default(unique)] +interface ICoreWebView2Controller2 : ICoreWebView2Controller { + /// The `DefaultBackgroundColor` property is the color WebView renders + /// underneath all web content. This means WebView renders this color when + /// there is no web content loaded such as before the initial navigation or + /// between navigations. This also means web pages with undefined css + /// background properties or background properties containing transparent + /// pixels will render their contents over this color. Web pages with defined + /// and opaque background properties that span the page will obscure the + /// `DefaultBackgroundColor` and display normally. The default value for this + /// property is white to resemble the native browser experience. + /// + /// The Color is specified by the COREWEBVIEW2_COLOR that represents an RGBA + /// value. The `A` represents an Alpha value, meaning + /// `DefaultBackgroundColor` can be transparent. In the case of a transparent + /// `DefaultBackgroundColor` WebView will render hosting app content as the + /// background. This Alpha value is not supported on Windows 7. Any `A` value + /// other than 255 will result in E_INVALIDARG on Windows 7. + /// It is supported on all other WebView compatible platforms. + /// + /// Semi-transparent colors are not currently supported by this API and + /// setting `DefaultBackgroundColor` to a semi-transparent color will fail + /// with E_INVALIDARG. The only supported alpha values are 0 and 255, all + /// other values will result in E_INVALIDARG. + /// `DefaultBackgroundColor` can only be an opaque color or transparent. + /// + /// This value may also be set by using the + /// `WEBVIEW2_DEFAULT_BACKGROUND_COLOR` environment variable. There is a + /// known issue with background color where setting the color by API can + /// still leave the app with a white flicker before the + /// `DefaultBackgroundColor` takes effect. Setting the color via environment + /// variable solves this issue. The value must be a hex value that can + /// optionally prepend a 0x. The value must account for the alpha value + /// which is represented by the first 2 digits. So any hex value fewer than 8 + /// digits will assume a prepended 00 to the hex value and result in a + /// transparent color. + /// `get_DefaultBackgroundColor` will return the result of this environment + /// variable if used. This environment variable can only set the + /// `DefaultBackgroundColor` once. Subsequent updates to background color + /// must be done through API call. + /// + /// \snippet ViewComponent.cpp DefaultBackgroundColor + [propget] HRESULT DefaultBackgroundColor( + [out, retval] COREWEBVIEW2_COLOR* backgroundColor); + + /// Sets the `DefaultBackgroundColor` property. + [propput] HRESULT DefaultBackgroundColor( + [in] COREWEBVIEW2_COLOR backgroundColor); +} + +/// A continuation of the ICoreWebView2Controller2 interface. +[uuid(f9614724-5d2b-41dc-aef7-73d62b51543b), object, pointer_default(unique)] +interface ICoreWebView2Controller3 : ICoreWebView2Controller2 { + /// The rasterization scale for the WebView. The rasterization scale is the + /// combination of the monitor DPI scale and text scaling set by the user. + /// This value should be updated when the DPI scale of the app's top level + /// window changes (i.e. monitor DPI scale changes or window changes monitor) + /// or when the text scale factor of the system changes. + /// + /// \snippet AppWindow.cpp DPIChanged + /// + /// \snippet AppWindow.cpp TextScaleChanged1 + /// + /// \snippet AppWindow.cpp TextScaleChanged2 + /// + /// Rasterization scale applies to the WebView content, as well as + /// popups, context menus, scroll bars, and so on. Normal app scaling + /// scenarios should use the ZoomFactor property or SetBoundsAndZoomFactor + /// API which only scale the rendered HTML content and not popups, context + /// menus, scroll bars, and so on. + /// + /// \snippet ViewComponent.cpp RasterizationScale + [propget] HRESULT RasterizationScale([out, retval] double* scale); + /// Set the rasterization scale property. + [propput] HRESULT RasterizationScale([in] double scale); + + /// ShouldDetectMonitorScaleChanges property determines whether the WebView + /// attempts to track monitor DPI scale changes. When true, the WebView will + /// track monitor DPI scale changes, update the RasterizationScale property, + /// and raises RasterizationScaleChanged event. When false, the WebView will + /// not track monitor DPI scale changes, and the app must update the + /// RasterizationScale property itself. RasterizationScaleChanged event will + /// never raise when ShouldDetectMonitorScaleChanges is false. Apps that want + /// to set their own rasterization scale should set this property to false to + /// avoid the WebView2 updating the RasterizationScale property to match the + /// monitor DPI scale. + [propget] HRESULT ShouldDetectMonitorScaleChanges([out, retval] BOOL* value); + /// Set the ShouldDetectMonitorScaleChanges property. + [propput] HRESULT ShouldDetectMonitorScaleChanges([in] BOOL value); + + /// Add an event handler for the RasterizationScaleChanged event. + /// The event is raised when the WebView detects that the monitor DPI scale + /// has changed, ShouldDetectMonitorScaleChanges is true, and the WebView has + /// changed the RasterizationScale property. + /// + /// \snippet ViewComponent.cpp RasterizationScaleChanged + HRESULT add_RasterizationScaleChanged( + [in] ICoreWebView2RasterizationScaleChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + /// Remove an event handler previously added with + /// add_RasterizationScaleChanged. + HRESULT remove_RasterizationScaleChanged( + [in] EventRegistrationToken token); + + /// BoundsMode affects how setting the Bounds and RasterizationScale + /// properties work. Bounds mode can either be in COREWEBVIEW2_BOUNDS_MODE_USE_RAW_PIXELS + /// mode or COREWEBVIEW2_BOUNDS_MODE_USE_RASTERIZATION_SCALE mode. + /// + /// When the mode is in COREWEBVIEW2_BOUNDS_MODE_USE_RAW_PIXELS, setting the bounds + /// property will set the size of the WebView in raw screen pixels. Changing + /// the rasterization scale in this mode won't change the raw pixel size of + /// the WebView and will only change the rasterization scale. + /// + /// When the mode is in COREWEBVIEW2_BOUNDS_MODE_USE_RASTERIZATION_SCALE, setting the + /// bounds property will change the logical size of the WebView which can be + /// described by the following equation: + /// ```text + /// Logical size * rasterization scale = Raw Pixel size + /// ``` + /// In this case, changing the rasterization scale will keep the logical size + /// the same and change the raw pixel size. + /// + /// \snippet ViewComponent.cpp BoundsMode + [propget] HRESULT BoundsMode( + [out, retval] COREWEBVIEW2_BOUNDS_MODE* boundsMode); + /// Set the BoundsMode property. + [propput] HRESULT BoundsMode([in] COREWEBVIEW2_BOUNDS_MODE boundsMode); +} + +/// This is the ICoreWebView2Controller4 interface. +/// The ICoreWebView2Controller4 provides interface to enable/disable external drop. +[uuid(97d418d5-a426-4e49-a151-e1a10f327d9e), object, pointer_default(unique)] +interface ICoreWebView2Controller4 : ICoreWebView2Controller3 { + /// Gets the `AllowExternalDrop` property which is used to configure the + /// capability that dragging objects from outside the bounds of webview2 and + /// dropping into webview2 is allowed or disallowed. The default value is + /// TRUE. + /// + /// \snippet SettingsComponent.cpp ToggleAllowExternalDrop + [propget] HRESULT AllowExternalDrop([ out, retval ] BOOL * value); + /// Sets the `AllowExternalDrop` property which is used to configure the + /// capability that dragging objects from outside the bounds of webview2 and + /// dropping into webview2 is allowed or disallowed. + /// + /// \snippet SettingsComponent.cpp ToggleAllowExternalDrop + [propput] HRESULT AllowExternalDrop([in] BOOL value); +} + +/// This interface is an extension of the ICoreWebView2Controller interface to +/// support visual hosting. An object implementing the +/// ICoreWebView2CompositionController interface will also implement +/// ICoreWebView2Controller. Callers are expected to use +/// ICoreWebView2Controller for resizing, visibility, focus, and so on, and +/// then use ICoreWebView2CompositionController to connect to a composition +/// tree and provide input meant for the WebView. +[uuid(3df9b733-b9ae-4a15-86b4-eb9ee9826469), object, pointer_default(unique)] +interface ICoreWebView2CompositionController : IUnknown { + /// The RootVisualTarget is a visual in the hosting app's visual tree. This + /// visual is where the WebView will connect its visual tree. The app uses + /// this visual to position the WebView within the app. The app still needs + /// to use the Bounds property to size the WebView. The RootVisualTarget + /// property can be an IDCompositionVisual or a + /// Windows::UI::Composition::ContainerVisual. WebView will connect its visual + /// tree to the provided visual before returning from the property setter. The + /// app needs to commit on its device setting the RootVisualTarget property. + /// The RootVisualTarget property supports being set to nullptr to disconnect + /// the WebView from the app's visual tree. + /// \snippet ViewComponent.cpp SetRootVisualTarget + /// \snippet ViewComponent.cpp BuildDCompTree + [propget] HRESULT RootVisualTarget([out, retval] IUnknown** target); + /// Set the RootVisualTarget property. + [propput] HRESULT RootVisualTarget([in] IUnknown* target); + + /// If eventKind is COREWEBVIEW2_MOUSE_EVENT_KIND_HORIZONTAL_WHEEL or + /// COREWEBVIEW2_MOUSE_EVENT_KIND_WHEEL, then mouseData specifies the amount of + /// wheel movement. A positive value indicates that the wheel was rotated + /// forward, away from the user; a negative value indicates that the wheel was + /// rotated backward, toward the user. One wheel click is defined as + /// WHEEL_DELTA, which is 120. + /// If eventKind is COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_DOUBLE_CLICK + /// COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_DOWN, or + /// COREWEBVIEW2_MOUSE_EVENT_KIND_X_BUTTON_UP, then mouseData specifies which X + /// buttons were pressed or released. This value should be 1 if the first X + /// button is pressed/released and 2 if the second X button is + /// pressed/released. + /// If eventKind is COREWEBVIEW2_MOUSE_EVENT_KIND_LEAVE, then virtualKeys, + /// mouseData, and point should all be zero. + /// If eventKind is any other value, then mouseData should be zero. + /// Point is expected to be in the client coordinate space of the WebView. + /// To track mouse events that start in the WebView and can potentially move + /// outside of the WebView and host application, calling SetCapture and + /// ReleaseCapture is recommended. + /// To dismiss hover popups, it is also recommended to send + /// COREWEBVIEW2_MOUSE_EVENT_KIND_LEAVE messages. + /// \snippet ViewComponent.cpp SendMouseInput + HRESULT SendMouseInput( + [in] COREWEBVIEW2_MOUSE_EVENT_KIND eventKind, + [in] COREWEBVIEW2_MOUSE_EVENT_VIRTUAL_KEYS virtualKeys, + [in] UINT32 mouseData, + [in] POINT point); + + /// SendPointerInput accepts touch or pen pointer input of types defined in + /// COREWEBVIEW2_POINTER_EVENT_KIND. Any pointer input from the system must be + /// converted into an ICoreWebView2PointerInfo first. + HRESULT SendPointerInput( + [in] COREWEBVIEW2_POINTER_EVENT_KIND eventKind, + [in] ICoreWebView2PointerInfo* pointerInfo); + + /// The current cursor that WebView thinks it should be. The cursor should be + /// set in WM_SETCURSOR through \::SetCursor or set on the corresponding + /// parent/ancestor HWND of the WebView through \::SetClassLongPtr. The HCURSOR + /// can be freed so CopyCursor/DestroyCursor is recommended to keep your own + /// copy if you are doing more than immediately setting the cursor. + [propget] HRESULT Cursor([out, retval] HCURSOR* cursor); + + /// The current system cursor ID reported by the underlying rendering engine + /// for WebView. For example, most of the time, when the cursor is over text, + /// this will return the int value for IDC_IBEAM. The systemCursorId is only + /// valid if the rendering engine reports a default Windows cursor resource + /// value. Navigate to + /// [LoadCursorW](/windows/win32/api/winuser/nf-winuser-loadcursorw) for more + /// details. Otherwise, if custom CSS cursors are being used, this will return + /// 0. To actually use systemCursorId in LoadCursor or LoadImage, + /// MAKEINTRESOURCE must be called on it first. + /// + /// \snippet ViewComponent.cpp SystemCursorId + [propget] HRESULT SystemCursorId([out, retval] UINT32* systemCursorId); + + /// Add an event handler for the CursorChanged event. + /// The event is raised when WebView thinks the cursor should be changed. For + /// example, when the mouse cursor is currently the default cursor but is then + /// moved over text, it may try to change to the IBeam cursor. + /// + /// It is expected for the developer to send + /// COREWEBVIEW2_MOUSE_EVENT_KIND_LEAVE messages (in addition to + /// COREWEBVIEW2_MOUSE_EVENT_KIND_MOVE messages) through the SendMouseInput + /// API. This is to ensure that the mouse is actually within the WebView that + /// sends out CursorChanged events. + /// + /// \snippet ViewComponent.cpp CursorChanged + HRESULT add_CursorChanged( + [in] ICoreWebView2CursorChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + /// Remove an event handler previously added with add_CursorChanged. + HRESULT remove_CursorChanged( + [in] EventRegistrationToken token); +} + +/// A continuation of the ICoreWebView2CompositionController interface. +[uuid(0b6a3d24-49cb-4806-ba20-b5e0734a7b26), object, pointer_default(unique)] +interface ICoreWebView2CompositionController2 : ICoreWebView2CompositionController { + /// Returns the Automation Provider for the WebView. This object implements + /// IRawElementProviderSimple. + [propget] HRESULT AutomationProvider([out, retval] IUnknown** provider); +} + + +/// This interface is the continuation of the +/// ICoreWebView2CompositionController2 interface to manage drag and drop. +[uuid(9570570e-4d76-4361-9ee1-f04d0dbdfb1e), object, pointer_default(unique)] +interface ICoreWebView2CompositionController3 : ICoreWebView2CompositionController2 { + /// This function corresponds to [IDropTarget::DragEnter](/windows/win32/api/oleidl/nf-oleidl-idroptarget-dragenter). + /// + /// This function has a dependency on AllowExternalDrop property of + /// CoreWebView2Controller and return E_FAIL to callers to indicate this + /// operation is not allowed if AllowExternalDrop property is set to false. + /// + /// The hosting application must register as an IDropTarget and implement + /// and forward DragEnter calls to this function. + /// + /// point parameter must be modified to include the WebView's offset and be in + /// the WebView's client coordinates (Similar to how SendMouseInput works). + /// + /// \snippet DropTarget.cpp DragEnter + HRESULT DragEnter( + [in] IDataObject* dataObject, + [in] DWORD keyState, + [in] POINT point, + [out, retval] DWORD* effect); + + /// This function corresponds to [IDropTarget::DragLeave](/windows/win32/api/oleidl/nf-oleidl-idroptarget-dragleave). + /// + /// This function has a dependency on AllowExternalDrop property of + /// CoreWebView2Controller and return E_FAIL to callers to indicate this + /// operation is not allowed if AllowExternalDrop property is set to false. + /// + /// The hosting application must register as an IDropTarget and implement + /// and forward DragLeave calls to this function. + /// + /// \snippet DropTarget.cpp DragLeave + HRESULT DragLeave(); + + /// This function corresponds to [IDropTarget::DragOver](/windows/win32/api/oleidl/nf-oleidl-idroptarget-dragover). + /// + /// This function has a dependency on AllowExternalDrop property of + /// CoreWebView2Controller and return E_FAIL to callers to indicate this + /// operation is not allowed if AllowExternalDrop property is set to false. + /// + /// The hosting application must register as an IDropTarget and implement + /// and forward DragOver calls to this function. + /// + /// point parameter must be modified to include the WebView's offset and be in + /// the WebView's client coordinates (Similar to how SendMouseInput works). + /// + /// \snippet DropTarget.cpp DragOver + HRESULT DragOver( + [in] DWORD keyState, + [in] POINT point, + [out, retval] DWORD* effect); + + /// This function corresponds to [IDropTarget::Drop](/windows/win32/api/oleidl/nf-oleidl-idroptarget-drop). + /// + /// This function has a dependency on AllowExternalDrop property of + /// CoreWebView2Controller and return E_FAIL to callers to indicate this + /// operation is not allowed if AllowExternalDrop property is set to false. + /// + /// The hosting application must register as an IDropTarget and implement + /// and forward Drop calls to this function. + /// + /// point parameter must be modified to include the WebView's offset and be in + /// the WebView's client coordinates (Similar to how SendMouseInput works). + /// + /// \snippet DropTarget.cpp Drop + HRESULT Drop( + [in] IDataObject* dataObject, + [in] DWORD keyState, + [in] POINT point, + [out, retval] DWORD* effect); +} + +/// This interface is used to complete deferrals on event args that support +/// getting deferrals using the `GetDeferral` method. + +[uuid(c10e7f7b-b585-46f0-a623-8befbf3e4ee0), object, pointer_default(unique)] +interface ICoreWebView2Deferral : IUnknown { + + /// Completes the associated deferred event. Complete should only be run + /// once for each deferral taken. + + HRESULT Complete(); +} + +/// Defines properties that enable, disable, or modify WebView features. +/// Changes to `IsGeneralAutofillEnabled` and `IsPasswordAutosaveEnabled` +/// apply immediately, while other setting changes made after `NavigationStarting` +/// event do not apply until the next top-level navigation. + +[uuid(e562e4f0-d7fa-43ac-8d71-c05150499f00), object, pointer_default(unique)] +interface ICoreWebView2Settings : IUnknown { + + /// Controls if running JavaScript is enabled in all future navigations in + /// the WebView. This only affects scripts in the document. Scripts + /// injected with `ExecuteScript` runs even if script is disabled. + /// The default value is `TRUE`. + /// + /// \snippet SettingsComponent.cpp IsScriptEnabled + [propget] HRESULT IsScriptEnabled( + [out, retval] BOOL* isScriptEnabled); + + /// Sets the `IsScriptEnabled` property. + [propput] HRESULT IsScriptEnabled([in] BOOL isScriptEnabled); + + /// The `IsWebMessageEnabled` property is used when loading a new HTML + /// document. If set to `TRUE`, communication from the host to the top-level + /// HTML document of the WebView is allowed using `PostWebMessageAsJson`, + /// `PostWebMessageAsString`, and message event of `window.chrome.webview`. + /// For more information, navigate to PostWebMessageAsJson. Communication + /// from the top-level HTML document of the WebView to the host is allowed + /// using the postMessage function of `window.chrome.webview` and + /// `add_WebMessageReceived` method. For more information, navigate to + /// [add_WebMessageReceived](/microsoft-edge/webview2/reference/win32/icorewebview2#add_webmessagereceived). + /// If set to false, then communication is disallowed. `PostWebMessageAsJson` + /// and `PostWebMessageAsString` fails with `E_ACCESSDENIED` and + /// `window.chrome.webview.postMessage` fails by throwing an instance of an + /// `Error` object. The default value is `TRUE`. + /// + /// \snippet ScenarioWebMessage.cpp IsWebMessageEnabled + [propget] HRESULT IsWebMessageEnabled( + [out, retval] BOOL* isWebMessageEnabled); + + /// Sets the `IsWebMessageEnabled` property. + [propput] HRESULT IsWebMessageEnabled([in] BOOL isWebMessageEnabled); + + /// `AreDefaultScriptDialogsEnabled` is used when loading a new HTML + /// document. If set to `FALSE`, WebView2 does not render the default JavaScript + /// dialog box (Specifically those displayed by the JavaScript alert, + /// confirm, prompt functions and `beforeunload` event). Instead, if an + /// event handler is set using `add_ScriptDialogOpening`, WebView sends an + /// event that contains all of the information for the dialog and allow the + /// host app to show a custom UI. + /// The default value is `TRUE`. + [propget] HRESULT AreDefaultScriptDialogsEnabled( + [out, retval] BOOL* areDefaultScriptDialogsEnabled); + + /// Sets the `AreDefaultScriptDialogsEnabled` property. + [propput] HRESULT AreDefaultScriptDialogsEnabled( + [in] BOOL areDefaultScriptDialogsEnabled); + + /// `IsStatusBarEnabled` controls whether the status bar is displayed. The + /// status bar is usually displayed in the lower left of the WebView and + /// shows things such as the URI of a link when the user hovers over it and + /// other information. + /// The default value is `TRUE`. + /// The status bar UI can be altered by web content and should not be considered secure. + [propget] HRESULT IsStatusBarEnabled([out, retval] BOOL* isStatusBarEnabled); + + /// Sets the `IsStatusBarEnabled` property. + [propput] HRESULT IsStatusBarEnabled([in] BOOL isStatusBarEnabled); + + /// `AreDevToolsEnabled` controls whether the user is able to use the context + /// menu or keyboard shortcuts to open the DevTools window. + /// The default value is `TRUE`. + [propget] HRESULT AreDevToolsEnabled([out, retval] BOOL* areDevToolsEnabled); + + /// Sets the `AreDevToolsEnabled` property. + [propput] HRESULT AreDevToolsEnabled([in] BOOL areDevToolsEnabled); + + /// The `AreDefaultContextMenusEnabled` property is used to prevent default + /// context menus from being shown to user in WebView. + /// The default value is `TRUE`. + /// + /// \snippet SettingsComponent.cpp DisableContextMenu + [propget] HRESULT AreDefaultContextMenusEnabled([out, retval] BOOL* enabled); + + /// Sets the `AreDefaultContextMenusEnabled` property. + [propput] HRESULT AreDefaultContextMenusEnabled([in] BOOL enabled); + + /// The `AreHostObjectsAllowed` property is used to control whether host + /// objects are accessible from the page in WebView. + /// The default value is `TRUE`. + /// + /// \snippet SettingsComponent.cpp HostObjectsAccess + [propget] HRESULT AreHostObjectsAllowed([out, retval] BOOL* allowed); + + /// Sets the `AreHostObjectsAllowed` property. + + [propput] HRESULT AreHostObjectsAllowed([in] BOOL allowed); + + /// The `IsZoomControlEnabled` property is used to prevent the user from + /// impacting the zoom of the WebView. When disabled, the user is not able + /// to zoom using Ctrl++, Ctrl+-, or Ctrl+mouse wheel, but the zoom + /// is set using `ZoomFactor` API. The default value is `TRUE`. + /// + /// \snippet SettingsComponent.cpp DisableZoomControl + + [propget] HRESULT IsZoomControlEnabled([out, retval] BOOL* enabled); + + /// Sets the `IsZoomControlEnabled` property. + + [propput] HRESULT IsZoomControlEnabled([in] BOOL enabled); + + /// The `IsBuiltInErrorPageEnabled` property is used to disable built in + /// error page for navigation failure and render process failure. When + /// disabled, a blank page is displayed when the related error happens. + /// The default value is `TRUE`. + /// + /// \snippet SettingsComponent.cpp BuiltInErrorPageEnabled + [propget] HRESULT IsBuiltInErrorPageEnabled([out, retval] BOOL* enabled); + + /// Sets the `IsBuiltInErrorPageEnabled` property. + [propput] HRESULT IsBuiltInErrorPageEnabled([in] BOOL enabled); +} + +/// A continuation of the ICoreWebView2Settings interface that manages the user agent. + +[uuid(ee9a0f68-f46c-4e32-ac23-ef8cac224d2a), object, pointer_default(unique)] +interface ICoreWebView2Settings2 : ICoreWebView2Settings { + /// Returns the User Agent. The default value is the default User Agent of the + /// Microsoft Edge browser. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + /// + /// \snippet SettingsComponent.cpp UserAgent + [propget] HRESULT UserAgent([out, retval] LPWSTR* userAgent); + /// Sets the `UserAgent` property. This property may be overridden if + /// the User-Agent header is set in a request. If the parameter is empty + /// the User Agent will not be updated and the current User Agent will remain. + /// Returns `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)` if the owning WebView is + /// closed. + [propput] HRESULT UserAgent([in] LPCWSTR userAgent); +} + +/// A continuation of the ICoreWebView2Settings interface that manages whether +/// browser accelerator keys are enabled. +[uuid(fdb5ab74-af33-4854-84f0-0a631deb5eba), object, pointer_default(unique)] +interface ICoreWebView2Settings3 : ICoreWebView2Settings2 { + /// When this setting is set to FALSE, it disables all accelerator keys that + /// access features specific to a web browser, including but not limited to: + /// - Ctrl-F and F3 for Find on Page + /// - Ctrl-P for Print + /// - Ctrl-R and F5 for Reload + /// - Ctrl-Plus and Ctrl-Minus for zooming + /// - Ctrl-Shift-C and F12 for DevTools + /// - Special keys for browser functions, such as Back, Forward, and Search + /// + /// It does not disable accelerator keys related to movement and text editing, + /// such as: + /// - Home, End, Page Up, and Page Down + /// - Ctrl-X, Ctrl-C, Ctrl-V + /// - Ctrl-A for Select All + /// - Ctrl-Z for Undo + /// + /// Those accelerator keys will always be enabled unless they are handled in + /// the `AcceleratorKeyPressed` event. + /// + /// This setting has no effect on the `AcceleratorKeyPressed` event. The event + /// will be fired for all accelerator keys, whether they are enabled or not. + /// + /// The default value for `AreBrowserAcceleratorKeysEnabled` is TRUE. + /// + /// \snippet SettingsComponent.cpp AreBrowserAcceleratorKeysEnabled + [propget] HRESULT AreBrowserAcceleratorKeysEnabled( + [out, retval] BOOL* areBrowserAcceleratorKeysEnabled); + + /// Sets the `AreBrowserAcceleratorKeysEnabled` property. + [propput] HRESULT AreBrowserAcceleratorKeysEnabled( + [in] BOOL areBrowserAcceleratorKeysEnabled); +} + +/// A continuation of the ICoreWebView2Settings interface to manage autofill. +[uuid(cb56846c-4168-4d53-b04f-03b6d6796ff2), object, pointer_default(unique)] +interface ICoreWebView2Settings4 : ICoreWebView2Settings3 { + /// IsPasswordAutosaveEnabled controls whether autosave for password + /// information is enabled. The IsPasswordAutosaveEnabled property behaves + /// independently of the IsGeneralAutofillEnabled property. When IsPasswordAutosaveEnabled is + /// false, no new password data is saved and no Save/Update Password prompts are displayed. + /// However, if there was password data already saved before disabling this setting, + /// then that password information is auto-populated, suggestions are shown and clicking on + /// one will populate the fields. + /// When IsPasswordAutosaveEnabled is true, password information is auto-populated, + /// suggestions are shown and clicking on one will populate the fields, new data + /// is saved, and a Save/Update Password prompt is displayed. + /// It will take effect immediately after setting. + /// The default value is `FALSE`. + /// This property has the same value as + /// `CoreWebView2Profile.IsPasswordAutosaveEnabled`, and changing one will + /// change the other. All `CoreWebView2`s with the same `CoreWebView2Profile` + /// will share the same value for this property, so for the `CoreWebView2`s + /// with the same profile, their + /// `CoreWebView2Settings.IsPasswordAutosaveEnabled` and + /// `CoreWebView2Profile.IsPasswordAutosaveEnabled` will always have the same + /// value. + /// + /// \snippet SettingsComponent.cpp PasswordAutosaveEnabled + [propget] HRESULT IsPasswordAutosaveEnabled([out, retval] BOOL* value); + + /// Set the IsPasswordAutosaveEnabled property. + [propput] HRESULT IsPasswordAutosaveEnabled([in] BOOL value); + + /// IsGeneralAutofillEnabled controls whether autofill for information + /// like names, street and email addresses, phone numbers, and arbitrary input + /// is enabled. This excludes password and credit card information. When + /// IsGeneralAutofillEnabled is false, no suggestions appear, and no new information + /// is saved. When IsGeneralAutofillEnabled is true, information is saved, suggestions + /// appear and clicking on one will populate the form fields. + /// It will take effect immediately after setting. + /// The default value is `TRUE`. + /// This property has the same value as + /// `CoreWebView2Profile.IsGeneralAutofillEnabled`, and changing one will + /// change the other. All `CoreWebView2`s with the same `CoreWebView2Profile` + /// will share the same value for this property, so for the `CoreWebView2`s + /// with the same profile, their + /// `CoreWebView2Settings.IsGeneralAutofillEnabled` and + /// `CoreWebView2Profile.IsGeneralAutofillEnabled` will always have the same + /// value. + /// + /// \snippet SettingsComponent.cpp GeneralAutofillEnabled + [propget] HRESULT IsGeneralAutofillEnabled([out, retval] BOOL* value); + + /// Set the IsGeneralAutofillEnabled property. + [propput] HRESULT IsGeneralAutofillEnabled([in] BOOL value); +} + +/// A continuation of the ICoreWebView2Settings interface to manage pinch zoom. +[uuid(183e7052-1d03-43a0-ab99-98e043b66b39), object, pointer_default(unique)] +interface ICoreWebView2Settings5 : ICoreWebView2Settings4 { + /// Pinch-zoom, referred to as "Page Scale" zoom, is performed as a post-rendering step, + /// it changes the page scale factor property and scales the surface the web page is + /// rendered onto when user performs a pinch zooming action. It does not change the layout + /// but rather changes the viewport and clips the web content, the content outside of the + /// viewport isn't visible onscreen and users can't reach this content using mouse. + /// + /// The `IsPinchZoomEnabled` property enables or disables the ability of + /// the end user to use a pinching motion on touch input enabled devices + /// to scale the web content in the WebView2. It defaults to `TRUE`. + /// When set to `FALSE`, the end user cannot pinch zoom after the next navigation. + /// Disabling/Enabling `IsPinchZoomEnabled` only affects the end user's ability to use + /// pinch motions and does not change the page scale factor. + /// This API only affects the Page Scale zoom and has no effect on the + /// existing browser zoom properties (`IsZoomControlEnabled` and `ZoomFactor`) + /// or other end user mechanisms for zooming. + /// + /// \snippet SettingsComponent.cpp TogglePinchZoomEnabled + [propget] HRESULT IsPinchZoomEnabled([out, retval] BOOL* enabled); + /// Set the `IsPinchZoomEnabled` property + [propput] HRESULT IsPinchZoomEnabled([in] BOOL enabled); +} + +/// A continuation of the ICoreWebView2Settings interface to manage swipe navigation. +[uuid(11cb3acd-9bc8-43b8-83bf-f40753714f87), object, pointer_default(unique)] +interface ICoreWebView2Settings6 : ICoreWebView2Settings5 { + /// The `IsSwipeNavigationEnabled` property enables or disables the ability of the + /// end user to use swiping gesture on touch input enabled devices to + /// navigate in WebView2. It defaults to `TRUE`. + /// + /// When this property is `TRUE`, then all configured navigation gestures are enabled: + /// 1. Swiping left and right to navigate forward and backward is always configured. + /// 2. Swiping down to refresh is off by default and not exposed via our API currently, + /// it requires the "--pull-to-refresh" option to be included in the additional browser + /// arguments to be configured. (See put_AdditionalBrowserArguments.) + /// + /// When set to `FALSE`, the end user cannot swipe to navigate or pull to refresh. + /// This API only affects the overscrolling navigation functionality and has no + /// effect on the scrolling interaction used to explore the web content shown + /// in WebView2. + /// + /// Disabling/Enabling IsSwipeNavigationEnabled takes effect after the + /// next navigation. + /// + /// \snippet SettingsComponent.cpp ToggleSwipeNavigationEnabled + [propget] HRESULT IsSwipeNavigationEnabled([out, retval] BOOL* enabled); + /// Set the `IsSwipeNavigationEnabled` property + [propput] HRESULT IsSwipeNavigationEnabled([in] BOOL enabled); +} + +/// A continuation of the ICoreWebView2Settings interface to hide Pdf toolbar items. +[uuid(488dc902-35ef-42d2-bc7d-94b65c4bc49c), object, pointer_default(unique)] +interface ICoreWebView2Settings7 : ICoreWebView2Settings6 { + /// `HiddenPdfToolbarItems` is used to customize the PDF toolbar items. By default, it is COREWEBVIEW2_PDF_TOOLBAR_ITEMS_NONE and so it displays all of the items. + /// Changes to this property apply to all CoreWebView2s in the same environment and using the same profile. + /// Changes to this setting apply only after the next navigation. + /// \snippet SettingsComponent.cpp ToggleHidePdfToolbarItems + [propget] HRESULT HiddenPdfToolbarItems([out, retval] COREWEBVIEW2_PDF_TOOLBAR_ITEMS* hidden_pdf_toolbar_items); + + /// Set the `HiddenPdfToolbarItems` property. + [propput] HRESULT HiddenPdfToolbarItems([in] COREWEBVIEW2_PDF_TOOLBAR_ITEMS hidden_pdf_toolbar_items); +} + +/// A continuation of the ICoreWebView2Settings interface to manage smartscreen. +[uuid(9e6b0e8f-86ad-4e81-8147-a9b5edb68650), object, pointer_default(unique)] +interface ICoreWebView2Settings8 : ICoreWebView2Settings7 { + /// SmartScreen helps webviews identify reported phishing and malware websites + /// and also helps users make informed decisions about downloads. + /// `IsReputationCheckingRequired` is used to control whether SmartScreen + /// enabled or not. SmartScreen is enabled or disabled for all CoreWebView2s + /// using the same user data folder. If + /// CoreWebView2Setting.IsReputationCheckingRequired is true for any + /// CoreWebView2 using the same user data folder, then SmartScreen is enabled. + /// If CoreWebView2Setting.IsReputationCheckingRequired is false for all + /// CoreWebView2 using the same user data folder, then SmartScreen is + /// disabled. When it is changed, the change will be applied to all WebViews + /// using the same user data folder on the next navigation or download. The + /// default value for `IsReputationCheckingRequired` is true. If the newly + /// created CoreWebview2 does not set SmartScreen to false, when + /// navigating(Such as Navigate(), LoadDataUrl(), ExecuteScript(), etc.), the + /// default value will be applied to all CoreWebview2 using the same user data + /// folder. + /// SmartScreen of WebView2 apps can be controlled by Windows system setting + /// "SmartScreen for Microsoft Edge", specially, for WebView2 in Windows + /// Store apps, SmartScreen is controlled by another Windows system setting + /// "SmartScreen for Microsoft Store apps". When the Windows setting is enabled, the + /// SmartScreen operates under the control of the `IsReputationCheckingRequired`. + /// When the Windows setting is disabled, the SmartScreen will be disabled + /// regardless of the `IsReputationCheckingRequired` value set in WebView2 apps. + /// In other words, under this circumstance the value of + /// `IsReputationCheckingRequired` will be saved but overridden by system setting. + /// Upon re-enabling the Windows setting, the CoreWebview2 will reference the + /// `IsReputationCheckingRequired` to determine the SmartScreen status. + /// \snippet SettingsComponent.cpp ToggleSmartScreen + [propget] HRESULT IsReputationCheckingRequired([out, retval] BOOL* value); + + /// Sets whether this webview2 instance needs SmartScreen protection for its content. + /// Set the `IsReputationCheckingRequired` property. + [propput] HRESULT IsReputationCheckingRequired([in] BOOL value); +} + +/// Event args for the `ProcessFailed` event. +[uuid(8155a9a4-1474-4a86-8cae-151b0fa6b8ca), object, pointer_default(unique)] +interface ICoreWebView2ProcessFailedEventArgs : IUnknown { + + /// The kind of process failure that has occurred. This is a combination of + /// process kind (for example, browser, renderer, gpu) and failure (exit, + /// unresponsiveness). Renderer processes are further divided in _main frame_ + /// renderer (`RenderProcessExited`, `RenderProcessUnresponsive`) and + /// _subframe_ renderer (`FrameRenderProcessExited`). To learn about the + /// conditions under which each failure kind occurs, see + /// `COREWEBVIEW2_PROCESS_FAILED_KIND`. + [propget] HRESULT ProcessFailedKind( + [out, retval] COREWEBVIEW2_PROCESS_FAILED_KIND* processFailedKind); +} + +/// Receives `ProcessFailed` events. +[uuid(79e0aea4-990b-42d9-aa1d-0fcc2e5bc7f1), object, pointer_default(unique)] +interface ICoreWebView2ProcessFailedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2ProcessFailedEventArgs* args); +} + +/// Implements the interface to receive `ZoomFactorChanged` events. Use the +/// `ICoreWebView2Controller.ZoomFactor` property to get the modified zoom +/// factor. + +[uuid(b52d71d6-c4df-4543-a90c-64a3e60f38cb), object, pointer_default(unique)] +interface ICoreWebView2ZoomFactorChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke([in] ICoreWebView2Controller* sender, [in] IUnknown* args); +} + +/// Iterator for a collection of HTTP headers. For more information, navigate +/// to ICoreWebView2HttpRequestHeaders and ICoreWebView2HttpResponseHeaders. +/// +/// \snippet ScenarioWebViewEventMonitor.cpp HttpRequestHeaderIterator +[uuid(0702fc30-f43b-47bb-ab52-a42cb552ad9f), object, pointer_default(unique)] +interface ICoreWebView2HttpHeadersCollectionIterator : IUnknown { + + /// Get the name and value of the current HTTP header of the iterator. If + /// the previous `MoveNext` operation set the `hasNext` parameter to `FALSE`, + /// this method fails. + /// + /// The caller must free the returned strings with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + HRESULT GetCurrentHeader([out] LPWSTR* name, [out] LPWSTR* value); + + /// `TRUE` when the iterator has not run out of headers. If the collection + /// over which the iterator is iterating is empty or if the iterator has gone + /// past the end of the collection then this is `FALSE`. + + [propget] HRESULT HasCurrentHeader([out, retval] BOOL* hasCurrent); + + /// Move the iterator to the next HTTP header in the collection. + /// + /// \> [!NOTE]\n \> If no more HTTP headers exist, the `hasNext` parameter is set to + /// `FALSE`. After this occurs the `GetCurrentHeader` method fails. + + HRESULT MoveNext([out, retval] BOOL* hasNext); +} + +/// HTTP request headers. Used to inspect the HTTP request on +/// `WebResourceRequested` event and `NavigationStarting` event. +/// +/// \> [!NOTE]\n\> It is possible to modify the HTTP request from a `WebResourceRequested` +/// event, but not from a `NavigationStarting` event. +[uuid(e86cac0e-5523-465c-b536-8fb9fc8c8c60), object, pointer_default(unique)] +interface ICoreWebView2HttpRequestHeaders : IUnknown { + + /// Gets the header value matching the name. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + HRESULT GetHeader([in] LPCWSTR name, [out, retval] LPWSTR* value); + + /// Gets the header value matching the name using an iterator. + + HRESULT GetHeaders([in] LPCWSTR name, [out, retval] ICoreWebView2HttpHeadersCollectionIterator** iterator); + + /// Verifies that the headers contain an entry that matches the header name. + + HRESULT Contains([in] LPCWSTR name, [out, retval] BOOL* contains); + + /// Adds or updates header that matches the name. + + HRESULT SetHeader([in] LPCWSTR name, [in] LPCWSTR value); + + /// Removes header that matches the name. + + HRESULT RemoveHeader([in] LPCWSTR name); + + /// Gets an iterator over the collection of request headers. + + HRESULT GetIterator( + [out, retval] ICoreWebView2HttpHeadersCollectionIterator** iterator); +} + +/// HTTP response headers. Used to construct a `WebResourceResponse` for the +/// `WebResourceRequested` event. +[uuid(03c5ff5a-9b45-4a88-881c-89a9f328619c), object, pointer_default(unique)] +interface ICoreWebView2HttpResponseHeaders : IUnknown { + + /// Appends header line with name and value. + + HRESULT AppendHeader([in] LPCWSTR name, [in] LPCWSTR value); + + /// Verifies that the headers contain entries that match the header name. + + HRESULT Contains([in] LPCWSTR name, [out, retval] BOOL* contains); + + /// Gets the first header value in the collection matching the name. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + HRESULT GetHeader([in] LPCWSTR name, [out, retval] LPWSTR* value); + + /// Gets the header values matching the name. + + HRESULT GetHeaders([in] LPCWSTR name, [out, retval] ICoreWebView2HttpHeadersCollectionIterator** iterator); + + /// Gets an iterator over the collection of entire response headers. + + HRESULT GetIterator( + [out, retval] ICoreWebView2HttpHeadersCollectionIterator** iterator); +} + +/// An HTTP request used with the `WebResourceRequested` event. +[uuid(97055cd4-512c-4264-8b5f-e3f446cea6a5), object, pointer_default(unique)] +interface ICoreWebView2WebResourceRequest : IUnknown { + + /// The request URI. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// Sets the `Uri` property. + + [propput] HRESULT Uri([in] LPCWSTR uri); + + /// The HTTP request method. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Method([out, retval] LPWSTR* method); + + /// Sets the `Method` property. + + [propput] HRESULT Method([in] LPCWSTR method); + + /// The HTTP request message body as stream. POST data should be here. If a + /// stream is set, which overrides the message body, the stream must have + /// all the content data available by the time the `WebResourceRequested` + /// event deferral of this response is completed. Stream should be agile or + /// be created from a background STA to prevent performance impact to the UI + /// thread. `Null` means no content data. `IStream` semantics apply + /// (return `S_OK` to `Read` runs until all data is exhausted). + + [propget] HRESULT Content([out, retval] IStream** content); + + /// Sets the `Content` property. + + [propput] HRESULT Content([in] IStream* content); + + /// The mutable HTTP request headers + + [propget] HRESULT Headers([out, retval] ICoreWebView2HttpRequestHeaders** headers); +} + +/// An HTTP response used with the `WebResourceRequested` event. +[uuid(aafcc94f-fa27-48fd-97df-830ef75aaec9), object, pointer_default(unique)] +interface ICoreWebView2WebResourceResponse : IUnknown { + + /// HTTP response content as stream. Stream must have all the content data + /// available by the time the `WebResourceRequested` event deferral of this + /// response is completed. Stream should be agile or be created from a + /// background thread to prevent performance impact to the UI thread. `Null` + /// means no content data. `IStream` semantics apply (return `S_OK` to + /// `Read` runs until all data is exhausted). + /// When providing the response data, you should consider relevant HTTP + /// request headers just like an HTTP server would do. For example, if the + /// request was for a video resource in a HTML video element, the request may + /// contain the [Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) + /// header to request only a part of the video that is streaming. In this + /// case, your response stream should be only the portion of the video + /// specified by the range HTTP request headers and you should set the + /// appropriate + /// [Content-Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header in the response. + + [propget] HRESULT Content([out, retval] IStream** content); + + /// Sets the `Content` property. + + [propput] HRESULT Content([in] IStream* content); + + /// Overridden HTTP response headers. + + [propget] HRESULT Headers([out, retval] ICoreWebView2HttpResponseHeaders** headers); + + /// The HTTP response status code. + + [propget] HRESULT StatusCode([out, retval] int* statusCode); + + /// Sets the `StatusCode` property. + + [propput] HRESULT StatusCode([in] int statusCode); + + /// The HTTP response reason phrase. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT ReasonPhrase([out, retval] LPWSTR* reasonPhrase); + + /// Sets the `ReasonPhrase` property. + + [propput] HRESULT ReasonPhrase([in] LPCWSTR reasonPhrase); +} + +/// Event args for the `NavigationStarting` event. +[uuid(5b495469-e119-438a-9b18-7604f25f2e49), object, pointer_default(unique)] +interface ICoreWebView2NavigationStartingEventArgs : IUnknown { + + /// The uri of the requested navigation. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// `TRUE` when the navigation was initiated through a user gesture as + /// opposed to programmatic navigation by page script. Navigations initiated + /// via WebView2 APIs are considered as user initiated. + + [propget] HRESULT IsUserInitiated([out, retval] BOOL* isUserInitiated); + + /// `TRUE` when the navigation is redirected. + + [propget] HRESULT IsRedirected([out, retval] BOOL* isRedirected); + + /// The HTTP request headers for the navigation. + /// + /// \> [!NOTE]\n\> You are not able to modify the HTTP request headers in a + /// `NavigationStarting` event. + + [propget] HRESULT RequestHeaders([out, retval] ICoreWebView2HttpRequestHeaders** requestHeaders); + + /// The host may set this flag to cancel the navigation. If set, the + /// navigation is not longer present and the content of the current page is + /// intact. For performance reasons, `GET` HTTP requests may happen, while + /// the host is responding. You may set cookies and use part of a request + /// for the navigation. Cancellation for navigation to `about:blank` or + /// frame navigation to `srcdoc` is not supported. Such attempts are + /// ignored. A cancelled navigation will fire a `NavigationCompleted` event + /// with a `WebErrorStatus` of + /// `COREWEBVIEW2_WEB_ERROR_STATUS_OPERATION_CANCELED`. + + [propget] HRESULT Cancel([out, retval] BOOL* cancel); + + /// Sets the `Cancel` property. + + [propput] HRESULT Cancel([in] BOOL cancel); + + /// The ID of the navigation. + + [propget] HRESULT NavigationId([out, retval] UINT64* navigationId); +} + +/// The AdditionalAllowedFrameAncestors API that enable developers to provide additional allowed frame ancestors. +[uuid(9086BE93-91AA-472D-A7E0-579F2BA006AD), object, pointer_default(unique)] +interface ICoreWebView2NavigationStartingEventArgs2 : ICoreWebView2NavigationStartingEventArgs { + + /// Get additional allowed frame ancestors set by the host app. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT AdditionalAllowedFrameAncestors([out, retval] LPWSTR* value); + + /// The app may set this property to allow a frame to be embedded by additional ancestors besides what is allowed by + /// http header [X-Frame-Options](https://developer.mozilla.org/docs/Web/HTTP/Headers/X-Frame-Options) + /// and [Content-Security-Policy frame-ancestors directive](https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors). + /// If set, a frame ancestor is allowed if it is allowed by the additional allowed frame + /// ancestors or original http header from the site. + /// Whether an ancestor is allowed by the additional allowed frame ancestors is done the same way as if the site provided + /// it as the source list of the Content-Security-Policy frame-ancestors directive. + /// For example, if `https://example.com` and `https://www.example.com` are the origins of the top + /// page and intermediate iframes that embed a nested site-embedding iframe, and you fully trust + /// those origins, you should set this property to `https://example.com https://www.example.com`. + /// This property gives the app the ability to use iframe to embed sites that otherwise + /// could not be embedded in an iframe in trusted app pages. + /// This could potentially subject the embedded sites to [Clickjacking](https://en.wikipedia.org/wiki/Clickjacking) + /// attack from the code running in the embedding web page. Therefore, you should only + /// set this property with origins of fully trusted embedding page and any intermediate iframes. + /// Whenever possible, you should use the list of specific origins of the top and intermediate + /// frames instead of wildcard characters for this property. + /// This API is to provide limited support for app scenarios that used to be supported by + /// `` element in other solutions like JavaScript UWP apps and Electron. + /// You should limit the usage of this property to trusted pages, and specific navigation + /// target url, by checking the `Source` of the WebView2, and `Uri` of the event args. + /// + /// This property is ignored for top level document navigation. + /// + /// \snippet ScriptComponent.cpp AdditionalAllowedFrameAncestors_1 + /// + /// \snippet ScriptComponent.cpp AdditionalAllowedFrameAncestors_2 + [propput] HRESULT AdditionalAllowedFrameAncestors([in] LPCWSTR value); + +} + +/// The NavigationKind API that enables developers to get more information about +/// navigation type. +[uuid(DDFFE494-4942-4BD2-AB73-35B8FF40E19F), object, pointer_default(unique)] +interface ICoreWebView2NavigationStartingEventArgs3 : ICoreWebView2NavigationStartingEventArgs2 { + + /// Get the navigation kind of this navigation. + /// + [propget] HRESULT NavigationKind([out, retval] COREWEBVIEW2_NAVIGATION_KIND* navigation_kind); + +} + +/// Receives `NavigationStarting` events. +[uuid(9adbe429-f36d-432b-9ddc-f8881fbd76e3), object, pointer_default(unique)] +interface ICoreWebView2NavigationStartingEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2NavigationStartingEventArgs* args); +} + +/// Event args for the `ContentLoading` event. +[uuid(0c8a1275-9b6b-4901-87ad-70df25bafa6e), object, pointer_default(unique)] +interface ICoreWebView2ContentLoadingEventArgs : IUnknown { + + /// `TRUE` if the loaded content is an error page. + + [propget] HRESULT IsErrorPage([out, retval] BOOL* isErrorPage); + + /// The ID of the navigation. + + [propget] HRESULT NavigationId([out, retval] UINT64* navigationId); +} + +/// Receives `ContentLoading` events. +[uuid(364471e7-f2be-4910-bdba-d72077d51c4b), object, pointer_default(unique)] +interface ICoreWebView2ContentLoadingEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] ICoreWebView2ContentLoadingEventArgs* args); +} + +/// Event args for the `SourceChanged` event. +[uuid(31e0e545-1dba-4266-8914-f63848a1f7d7), object, pointer_default(unique)] +interface ICoreWebView2SourceChangedEventArgs : IUnknown { + + /// `TRUE` if the page being navigated to is a new document. + + [propget] HRESULT IsNewDocument([out, retval] BOOL* isNewDocument); +} + +/// Receives `SourceChanged` events. +[uuid(3c067f9f-5388-4772-8b48-79f7ef1ab37c), object, pointer_default(unique)] +interface ICoreWebView2SourceChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] ICoreWebView2SourceChangedEventArgs* args); +} + +/// Receives `HistoryChanged` events. +[uuid(c79a420c-efd9-4058-9295-3e8b4bcab645), object, pointer_default(unique)] +interface ICoreWebView2HistoryChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] IUnknown* args); +} + +/// Event args for the `ScriptDialogOpening` event. +[uuid(7390bb70-abe0-4843-9529-f143b31b03d6), object, pointer_default(unique)] +interface ICoreWebView2ScriptDialogOpeningEventArgs : IUnknown { + + /// The URI of the page that requested the dialog box. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// The kind of JavaScript dialog box. `alert`, `confirm`, `prompt`, or + /// `beforeunload`. + + [propget] HRESULT Kind([out, retval] COREWEBVIEW2_SCRIPT_DIALOG_KIND* kind); + + /// The message of the dialog box. From JavaScript this is the first + /// parameter passed to `alert`, `confirm`, and `prompt` and is empty for + /// `beforeunload`. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Message([out, retval] LPWSTR* message); + + /// The host may run this to respond with **OK** to `confirm`, `prompt`, and + /// `beforeunload` dialogs. Do not run this method to indicate cancel. + /// From JavaScript, this means that the `confirm` and `beforeunload` function + /// returns `TRUE` if `Accept` is run. And for the prompt function it returns + /// the value of `ResultText` if `Accept` is run and otherwise returns + /// `FALSE`. + + HRESULT Accept(); + + /// The second parameter passed to the JavaScript prompt dialog. + /// The result of the prompt JavaScript function uses this value as the + /// default value. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT DefaultText([out, retval] LPWSTR* defaultText); + + /// The return value from the JavaScript prompt function if `Accept` is run. + /// This value is ignored for dialog kinds other than prompt. If `Accept` + /// is not run, this value is ignored and `FALSE` is returned from prompt. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT ResultText([out, retval] LPWSTR* resultText); + + /// Sets the `ResultText` property. + + [propput] HRESULT ResultText([in] LPCWSTR resultText); + + /// Returns an `ICoreWebView2Deferral` object. Use this operation to + /// complete the event at a later time. + + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); +} + +/// Receives `ScriptDialogOpening` events. +[uuid(ef381bf9-afa8-4e37-91c4-8ac48524bdfb), object, pointer_default(unique)] +interface ICoreWebView2ScriptDialogOpeningEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2ScriptDialogOpeningEventArgs* args); +} + +/// Event args for the `NavigationCompleted` event. +[uuid(30d68b7d-20d9-4752-a9ca-ec8448fbb5c1), object, pointer_default(unique)] +interface ICoreWebView2NavigationCompletedEventArgs : IUnknown { + + /// `TRUE` when the navigation is successful. `FALSE` for a navigation that + /// ended up in an error page (failures due to no network, DNS lookup + /// failure, HTTP server responds with 4xx), but may also be `FALSE` for + /// additional scenarios such as `window.stop()` run on navigated page. + /// Note that WebView2 will report the navigation as 'unsuccessful' if the load + /// for the navigation did not reach the expected completion for any reason. Such + /// reasons include potentially catastrophic issues such network and certificate + /// issues, but can also be the result of intended actions such as the app canceling a navigation or + /// navigating away before the original navigation completed. Applications should not + /// just rely on this flag, but also consider the reported WebErrorStatus to + /// determine whether the failure is indeed catastrophic in their context. + /// WebErrorStatuses that may indicate a non-catastrophic failure include: + /// - COREWEBVIEW2_WEB_ERROR_STATUS_OPERATION_CANCELED + /// - COREWEBVIEW2_WEB_ERROR_STATUS_VALID_AUTHENTICATION_CREDENTIALS_REQUIRED + /// - COREWEBVIEW2_WEB_ERROR_STATUS_VALID_PROXY_AUTHENTICATION_REQUIRED + + [propget] HRESULT IsSuccess([out, retval] BOOL* isSuccess); + + /// The error code if the navigation failed. + + [propget] HRESULT WebErrorStatus([out, retval] COREWEBVIEW2_WEB_ERROR_STATUS* + webErrorStatus); + + /// The ID of the navigation. + + [propget] HRESULT NavigationId([out, retval] UINT64* navigationId); +} + +/// This is an interface for the StatusCode property of +/// ICoreWebView2NavigationCompletedEventArgs +[uuid(FDF8B738-EE1E-4DB2-A329-8D7D7B74D792), object, pointer_default(unique)] +interface ICoreWebView2NavigationCompletedEventArgs2 : ICoreWebView2NavigationCompletedEventArgs { + /// The HTTP status code of the navigation if it involved an HTTP request. + /// For instance, this will usually be 200 if the request was successful, 404 + /// if a page was not found, etc. See + /// https://developer.mozilla.org/docs/Web/HTTP/Status for a list of + /// common status codes. + /// + /// The `HttpStatusCode` property will be 0 in the following cases: + /// * The navigation did not involve an HTTP request. For instance, if it was + /// a navigation to a file:// URL, or if it was a same-document navigation. + /// * The navigation failed before a response was received. For instance, if + /// the hostname was not found, or if there was a network error. + /// + /// In those cases, you can get more information from the `IsSuccess` and + /// `WebErrorStatus` properties. + /// + /// If the navigation receives a successful HTTP response, but the navigated + /// page calls `window.stop()` before it finishes loading, then + /// `HttpStatusCode` may contain a success code like 200, but `IsSuccess` will + /// be FALSE and `WebErrorStatus` will be + /// `COREWEBVIEW2_WEB_ERROR_STATUS_CONNECTION_ABORTED`. + /// + /// Since WebView2 handles HTTP continuations and redirects automatically, it + /// is unlikely for `HttpStatusCode` to ever be in the 1xx or 3xx ranges. + [propget] HRESULT HttpStatusCode([out, retval] int* http_status_code); +} + +/// Receives `NavigationCompleted` events. +[uuid(d33a35bf-1c49-4f98-93ab-006e0533fe1c), object, pointer_default(unique)] +interface ICoreWebView2NavigationCompletedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2NavigationCompletedEventArgs* args); +} + +/// Event args for the `PermissionRequested` event. +[uuid(973ae2ef-ff18-4894-8fb2-3c758f046810), object, pointer_default(unique)] +interface ICoreWebView2PermissionRequestedEventArgs : IUnknown { + + /// The origin of the web content that requests the permission. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// The type of the permission that is requested. + + [propget] HRESULT PermissionKind([out, retval] COREWEBVIEW2_PERMISSION_KIND* permissionKind); + + /// `TRUE` when the permission request was initiated through a user gesture. + /// + /// \> [!NOTE]\n\> Being initiated through a user gesture does not mean that user intended + /// to access the associated resource. + + [propget] HRESULT IsUserInitiated([out, retval] BOOL* isUserInitiated); + + /// The status of a permission request, (for example is the request is granted). + /// The default value is `COREWEBVIEW2_PERMISSION_STATE_DEFAULT`. + + [propget] HRESULT State([out, retval] COREWEBVIEW2_PERMISSION_STATE* state); + + /// Sets the `State` property. + + [propput] HRESULT State([in] COREWEBVIEW2_PERMISSION_STATE state); + + /// Gets an `ICoreWebView2Deferral` object. Use the deferral object to make + /// the permission decision at a later time. The deferral only applies to the + /// current request, and does not prevent the `PermissionRequested` event from + /// getting raised for new requests. However, for some permission kinds the + /// WebView will avoid creating a new request if there is a pending request of + /// the same kind. + + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); +} + +/// Receives `PermissionRequested` events. +[uuid(15e1c6a3-c72a-4df3-91d7-d097fbec6bfd), object, pointer_default(unique)] +interface ICoreWebView2PermissionRequestedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2PermissionRequestedEventArgs* args); +} + +/// Receives the result of the `AddScriptToExecuteOnDocumentCreated` method. +[uuid(b99369f3-9b11-47b5-bc6f-8e7895fcea17), object, pointer_default(unique)] +interface ICoreWebView2AddScriptToExecuteOnDocumentCreatedCompletedHandler : IUnknown { + + /// Provide the completion status and result of the corresponding + /// asynchronous method. + + HRESULT Invoke([in] HRESULT errorCode, [in] LPCWSTR id); +} + +/// Receives the result of the `ExecuteScript` method. +[uuid(49511172-cc67-4bca-9923-137112f4c4cc), object, pointer_default(unique)] +interface ICoreWebView2ExecuteScriptCompletedHandler : IUnknown { + + /// Provide the implementer with the completion status and result of the + /// corresponding asynchronous method. + + HRESULT Invoke([in] HRESULT errorCode, [in] LPCWSTR resultObjectAsJson); +} + +/// Event args for the `WebResourceRequested` event. +[uuid(453e667f-12c7-49d4-be6d-ddbe7956f57a), object, pointer_default(unique)] +interface ICoreWebView2WebResourceRequestedEventArgs : IUnknown { + + /// The Web resource request. The request object may be missing some headers + /// that are added by network stack at a later time. + + [propget] HRESULT Request([out, retval] ICoreWebView2WebResourceRequest** request); + + /// A placeholder for the web resource response object. If this object is + /// set, the web resource request is completed with the specified response. + + [propget] HRESULT Response([out, retval] ICoreWebView2WebResourceResponse** response); + + /// Sets the `Response` property. Create an empty web resource response + /// object with `CreateWebResourceResponse` and then modify it to construct + /// the response. + + [propput] HRESULT Response([in] ICoreWebView2WebResourceResponse* response); + + /// Obtain an `ICoreWebView2Deferral` object and put the event into a + /// deferred state. Use the `ICoreWebView2Deferral` object to complete the + /// request at a later time. + + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); + + /// The web resource request context. + + [propget] HRESULT ResourceContext([out, retval] COREWEBVIEW2_WEB_RESOURCE_CONTEXT* context); +} + +/// Runs when a URL request (through network, file, and so on) is made in +/// the webview for a Web resource matching resource context filter and URL +/// specified in `AddWebResourceRequestedFilter`. The host views and modifies +/// the request or provide a response in a similar pattern to HTTP, in which +/// case the request immediately completed. This may not contain any request +/// headers that are added by the network stack, such as an `Authorization` +/// header. +[uuid(ab00b74c-15f1-4646-80e8-e76341d25d71), object, pointer_default(unique)] +interface ICoreWebView2WebResourceRequestedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2WebResourceRequestedEventArgs* args); +} + +/// Receives the result of the `CapturePreview` method. The result is written +/// to the stream provided in the `CapturePreview` method. + +[uuid(697e05e9-3d8f-45fa-96f4-8ffe1ededaf5), object, pointer_default(unique)] +interface ICoreWebView2CapturePreviewCompletedHandler : IUnknown { + + /// Provides the completion status of the corresponding asynchronous method. + + HRESULT Invoke([in] HRESULT errorCode); +} + +/// Receives `GotFocus` and `LostFocus` events. + +[uuid(05ea24bd-6452-4926-9014-4b82b498135d), object, pointer_default(unique)] +interface ICoreWebView2FocusChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke( + [in] ICoreWebView2Controller* sender, + [in] IUnknown* args); +} + +/// Event args for the `MoveFocusRequested` event. + +[uuid(2d6aa13b-3839-4a15-92fc-d88b3c0d9c9d), object, pointer_default(unique)] +interface ICoreWebView2MoveFocusRequestedEventArgs : IUnknown { + + /// The reason for WebView to run the `MoveFocusRequested` event. + + [propget] HRESULT Reason([out, retval] COREWEBVIEW2_MOVE_FOCUS_REASON* reason); + + /// Indicates whether the event has been handled by the app. If the app has + /// moved the focus to another desired location, it should set the `Handled` + /// property to `TRUE`. When the `Handled` property is `FALSE` after the + /// event handler returns, default action is taken. The default action is to + /// try to find the next tab stop child window in the app and try to move + /// focus to that window. If no other window exists to move focus, focus is + /// cycled within the web content of the WebView. + + [propget] HRESULT Handled([out, retval] BOOL* value); + + /// Sets the `Handled` property. + + [propput] HRESULT Handled([in] BOOL value); +} + +/// Receives `MoveFocusRequested` events. + +[uuid(69035451-6dc7-4cb8-9bce-b2bd70ad289f), object, pointer_default(unique)] +interface ICoreWebView2MoveFocusRequestedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2Controller* sender, + [in] ICoreWebView2MoveFocusRequestedEventArgs* args); +} + +/// Event args for the `WebMessageReceived` event. +[uuid(0f99a40c-e962-4207-9e92-e3d542eff849), object, pointer_default(unique)] +interface ICoreWebView2WebMessageReceivedEventArgs : IUnknown { + + /// The URI of the document that sent this web message. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Source([out, retval] LPWSTR* source); + + /// The message posted from the WebView content to the host converted to a + /// JSON string. Run this operation to communicate using JavaScript objects. + /// + /// For example, the following `postMessage` runs result in the following + /// `WebMessageAsJson` values. + /// + /// ```json + /// postMessage({'a': 'b'}) L"{\"a\": \"b\"}" + /// postMessage(1.2) L"1.2" + /// postMessage('example') L"\"example\"" + /// ``` + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT WebMessageAsJson([out, retval] LPWSTR* webMessageAsJson); + + /// If the message posted from the WebView content to the host is a string + /// type, this method returns the value of that string. If the message + /// posted is some other kind of JavaScript type this method fails with the + /// following error. + /// + /// ```text + /// E_INVALIDARG + /// ``` + /// + /// Run this operation to communicate using simple strings. + /// + /// For example, the following `postMessage` runs result in the following + /// `WebMessageAsString` values. + /// + /// ```json + /// postMessage({'a': 'b'}) E_INVALIDARG + /// postMessage(1.2) E_INVALIDARG + /// postMessage('example') L"example" + /// ``` + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + HRESULT TryGetWebMessageAsString([out, retval] LPWSTR* webMessageAsString); +} + +/// Receives `WebMessageReceived` events. +[uuid(57213f19-00e6-49fa-8e07-898ea01ecbd2), object, pointer_default(unique)] +interface ICoreWebView2WebMessageReceivedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2WebMessageReceivedEventArgs* args); +} + +/// Event args for the `DevToolsProtocolEventReceived` event. +[uuid(653c2959-bb3a-4377-8632-b58ada4e66c4), object, pointer_default(unique)] +interface ICoreWebView2DevToolsProtocolEventReceivedEventArgs : IUnknown { + + /// The parameter object of the corresponding `DevToolsProtocol` event + /// represented as a JSON string. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT ParameterObjectAsJson([out, retval] LPWSTR* + parameterObjectAsJson); +} + +/// This is a continuation of the `ICoreWebView2DevToolsProtocolEventReceivedEventArgs` +/// interface that provides the session ID of the target where the event originates from. +[uuid(2DC4959D-1494-4393-95BA-BEA4CB9EBD1B), object, pointer_default(unique)] +interface ICoreWebView2DevToolsProtocolEventReceivedEventArgs2 : ICoreWebView2DevToolsProtocolEventReceivedEventArgs { + + /// The sessionId of the target where the event originates from. + /// Empty string is returned as sessionId if the event comes from the default + /// session for the top page. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + /// + /// \snippet ScriptComponent.cpp DevToolsProtocolEventReceivedSessionId + [propget] HRESULT SessionId([out, retval] LPWSTR* sessionId); +} + +/// Receives `DevToolsProtocolEventReceived` events from the WebView. +[uuid(e2fda4be-5456-406c-a261-3d452138362c), object, pointer_default(unique)] +interface ICoreWebView2DevToolsProtocolEventReceivedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2DevToolsProtocolEventReceivedEventArgs* args); +} + +/// Receives `CallDevToolsProtocolMethod` completion results. +[uuid(5c4889f0-5ef6-4c5a-952c-d8f1b92d0574), object, pointer_default(unique)] +interface ICoreWebView2CallDevToolsProtocolMethodCompletedHandler : IUnknown { + + /// Provides the completion status and result of the corresponding + /// asynchronous method. + + HRESULT Invoke([in] HRESULT errorCode, [in] LPCWSTR returnObjectAsJson); +} + +/// Receives the `CoreWebView2Controller` created using `CreateCoreWebView2Controller`. + +[uuid(6c4819f3-c9b7-4260-8127-c9f5bde7f68c), object, pointer_default(unique)] +interface ICoreWebView2CreateCoreWebView2ControllerCompletedHandler : IUnknown { + + /// Provides the completion status and result of the corresponding + /// asynchronous method. + + HRESULT Invoke(HRESULT errorCode, ICoreWebView2Controller* createdController); +} + +/// The caller implements this interface to receive the CoreWebView2Controller +/// created via CreateCoreWebView2CompositionController. +[uuid(02fab84b-1428-4fb7-ad45-1b2e64736184), object, pointer_default(unique)] +interface ICoreWebView2CreateCoreWebView2CompositionControllerCompletedHandler : IUnknown { + /// Called to provide the implementer with the completion status and result + /// of the corresponding asynchronous method call. + HRESULT Invoke( + HRESULT errorCode, + ICoreWebView2CompositionController* webView); +} + +/// Event args for the `NewWindowRequested` event. The event is run when +/// content inside webview requested to a open a new window (through +/// `window.open()` and so on). +[uuid(34acb11c-fc37-4418-9132-f9c21d1eafb9), object, pointer_default(unique)] +interface ICoreWebView2NewWindowRequestedEventArgs : IUnknown { + + /// The target uri of the new window requested. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// Sets a CoreWebView2 as a result of the NewWindowRequested event. Provides + /// a WebView as the target for a `window.open()` from inside the + /// requesting WebView. If this is set, the top-level window of this WebView + /// is returned as the opened + /// [WindowProxy](https://developer.mozilla.org/en-US/docs/glossary/windowproxy) + /// to the opener script. If this is not set, then `Handled` is checked to + /// determine behavior for NewWindowRequested event. + /// CoreWebView2 provided in the `NewWindow` property must be on the same + /// Environment as the opener WebView and should not have been navigated + /// previously. Don't use methods that cause navigation or interact with the + /// DOM on this CoreWebView2 until the target content has loaded. Setting event + /// handlers, changing Settings properties, or other methods are fine to call. + /// Changes to settings should be made before `put_NewWindow` is called to + /// ensure that those settings take effect for the newly setup WebView. Once the + /// NewWindow is set the underlying web contents of this CoreWebView2 will be + /// replaced and navigated as appropriate for the new window. After setting + /// new window it cannot be changed and error will be return otherwise. + /// + /// The methods which should affect the new web contents like + /// AddScriptToExecuteOnDocumentCreated has to be called and completed before setting NewWindow. + /// Other methods which should affect the new web contents like add_WebResourceRequested have to be called after setting NewWindow. + /// It is best not to use RemoveScriptToExecuteOnDocumentCreated before setting NewWindow, otherwise it may not work for later added scripts. + /// + /// The new WebView must have the same profile as the opener WebView. + + [propput] HRESULT NewWindow([in] ICoreWebView2* newWindow); + + /// Gets the new window. + + [propget] HRESULT NewWindow([out, retval] ICoreWebView2** newWindow); + + /// Sets whether the `NewWindowRequested` event is handled by host. If this + /// is `FALSE` and no `NewWindow` is set, the WebView opens a popup window + /// and it returns as opened `WindowProxy`. If set to `TRUE` and no + /// `NewWindow` is set for `window.open`, the opened `WindowProxy` is for an + /// testing window object and no window loads. + /// The default value is `FALSE`. + + [propput] HRESULT Handled([in] BOOL handled); + + /// Gets whether the `NewWindowRequested` event is handled by host. + + [propget] HRESULT Handled([out, retval] BOOL* handled); + + /// `TRUE` when the new window request was initiated through a user gesture. + /// Examples of user initiated requests are: + /// + /// - Selecting an anchor tag with target + /// - Programmatic window open from a script that directly run as a result of + /// user interaction such as via onclick handlers. + /// + /// Non-user initiated requests are programmatic window opens from a script + /// that are not directly triggered by user interaction, such as those that + /// run while loading a new page or via timers. + /// The Microsoft Edge popup blocker is disabled for WebView so the app is + /// able to use this flag to block non-user initiated popups. + + [propget] HRESULT IsUserInitiated([out, retval] BOOL* isUserInitiated); + + /// Obtain an `ICoreWebView2Deferral` object and put the event into a + /// deferred state. Use the `ICoreWebView2Deferral` object to complete the + /// window open request at a later time. While this event is deferred the + /// opener window returns a `WindowProxy` to an un-navigated window, which + /// navigates when the deferral is complete. + + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); + + /// Window features specified by the `window.open`. The features should be + /// considered for positioning and sizing of new webview windows. + + [propget] HRESULT WindowFeatures([out, retval] ICoreWebView2WindowFeatures** value); +} + +/// This is a continuation of the `ICoreWebView2NewWindowRequestedEventArgs` interface. +[uuid(bbc7baed-74c6-4c92-b63a-7f5aeae03de3), object, pointer_default(unique)] +interface ICoreWebView2NewWindowRequestedEventArgs2 : ICoreWebView2NewWindowRequestedEventArgs { + /// Gets the name of the new window. This window can be created via `window.open(url, windowName)`, + /// where the windowName parameter corresponds to `Name` property. + /// If no windowName is passed to `window.open`, then the `Name` property + /// will be set to an empty string. Additionally, if window is opened through other means, + /// such as `...` or ``, + /// then the `Name` property will be set accordingly. In the case of target=_blank, + /// the `Name` property will be an empty string. + /// Opening a window via ctrl+clicking a link would result in the `Name` property + /// being set to an empty string. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Name([out, retval] LPWSTR* value); +} + +/// The window features for a WebView popup window. The fields match the +/// `windowFeatures` passed to `window.open` as specified in +/// [Window features](https://developer.mozilla.org/docs/Web/API/Window/open#Window_features) +/// on MDN. +/// +/// There is no requirement for you to respect the values. If your app does +/// not have corresponding UI features (for example, no toolbar) or if all +/// instance of WebView are opened in tabs and do not have distinct size or +/// positions, then your app does not respect the values. You may want to +/// respect values, but perhaps only some apply to the UI of you app. +/// Accordingly, you may respect all, some, or none of the properties as +/// appropriate for your app. For all numeric properties, if the value that is +/// passed to `window.open` is outside the range of an unsigned 32bit int, the +/// resulting value is the absolute value of the maximum for unsigned 32bit +/// integer. If you are not able to parse the value an integer, it is +/// considered `0`. If the value is a floating point value, it is rounded down +/// to an integer. +/// +/// In runtime versions 98 or later, the values of `ShouldDisplayMenuBar`, +/// `ShouldDisplayStatus`, `ShouldDisplayToolbar`, and `ShouldDisplayScrollBars` +/// will not directly depend on the equivalent fields in the `windowFeatures` +/// string. Instead, they will all be false if the window is expected to be a +/// popup, and true if it is not. +[uuid(5eaf559f-b46e-4397-8860-e422f287ff1e), object, pointer_default(unique)] +interface ICoreWebView2WindowFeatures : IUnknown { + + /// Specifies left and top values. + + [propget] HRESULT HasPosition([out, retval] BOOL* value); + + /// Specifies height and width values. + + [propget] HRESULT HasSize([out, retval] BOOL* value); + + /// Specifies the left position of the window. If `HasPosition` is set to + /// `FALSE`, this field is ignored. + + [propget] HRESULT Left([out, retval] UINT32* value); + + /// Specifies the top position of the window. If `HasPosition` is set to + /// `FALSE`, this field is ignored. + + [propget] HRESULT Top([out, retval] UINT32* value); + + /// Specifies the height of the window. Minimum value is `100`. If + /// `HasSize` is set to `FALSE`, this field is ignored. + + [propget] HRESULT Height([out, retval] UINT32* value); + + /// Specifies the width of the window. Minimum value is `100`. If `HasSize` + /// is set to `FALSE`, this field is ignored. + + [propget] HRESULT Width([out, retval] UINT32* value); + + /// Indicates that the menu bar is displayed. + + [propget] HRESULT ShouldDisplayMenuBar([out, retval] BOOL* value); + + /// Indicates that the status bar is displayed. + + [propget] HRESULT ShouldDisplayStatus([out, retval] BOOL* value); + + /// Indicates that the browser toolbar is displayed. + + [propget] HRESULT ShouldDisplayToolbar([out, retval] BOOL* value); + + /// Indicates that the scroll bars are displayed. + + [propget] HRESULT ShouldDisplayScrollBars([out, retval] BOOL* value); +} + +/// Receives `NewWindowRequested` events. +[uuid(d4c185fe-c81c-4989-97af-2d3fa7ab5651), object, pointer_default(unique)] +interface ICoreWebView2NewWindowRequestedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2NewWindowRequestedEventArgs* args); +} + +/// Receives `DocumentTitleChanged` events. Use the `DocumentTitle` property +/// to get the modified title. + +[uuid(f5f2b923-953e-4042-9f95-f3a118e1afd4), object, pointer_default(unique)] +interface ICoreWebView2DocumentTitleChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] IUnknown* args); +} + +/// Event args for the `AcceleratorKeyPressed` event. + +[uuid(9f760f8a-fb79-42be-9990-7b56900fa9c7), object, pointer_default(unique)] +interface ICoreWebView2AcceleratorKeyPressedEventArgs : IUnknown { + + /// The key event type that caused the event to run. + + [propget] HRESULT KeyEventKind([out, retval] COREWEBVIEW2_KEY_EVENT_KIND* keyEventKind); + + /// The Win32 virtual key code of the key that was pressed or released. It + /// is one of the Win32 virtual key constants such as `VK_RETURN` or an + /// (uppercase) ASCII value such as `A`. Verify whether Ctrl or Alt + /// are pressed by running `GetKeyState(VK_CONTROL)` or + /// `GetKeyState(VK_MENU)`. + + [propget] HRESULT VirtualKey([out, retval] UINT* virtualKey); + + /// The `LPARAM` value that accompanied the window message. For more + /// information, navigate to [WM_KEYDOWN](/windows/win32/inputdev/wm-keydown) + /// and [WM_KEYUP](/windows/win32/inputdev/wm-keyup). + + [propget] HRESULT KeyEventLParam([out, retval] INT* lParam); + + /// A structure representing the information passed in the `LPARAM` of the + /// window message. + + [propget] HRESULT PhysicalKeyStatus( + [out, retval] COREWEBVIEW2_PHYSICAL_KEY_STATUS* physicalKeyStatus); + + /// During `AcceleratorKeyPressedEvent` handler invocation the WebView is + /// blocked waiting for the decision of if the accelerator is handled by the + /// host (or not). If the `Handled` property is set to `TRUE` then this + /// prevents the WebView from performing the default action for this + /// accelerator key. Otherwise the WebView performs the default action for + /// the accelerator key. + + [propget] HRESULT Handled([out, retval] BOOL* handled); + + /// Sets the `Handled` property. + + [propput] HRESULT Handled([in] BOOL handled); +} + +/// Receives `AcceleratorKeyPressed` events. + +[uuid(b29c7e28-fa79-41a8-8e44-65811c76dcb2), object, pointer_default(unique)] +interface ICoreWebView2AcceleratorKeyPressedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke( + [in] ICoreWebView2Controller* sender, + [in] ICoreWebView2AcceleratorKeyPressedEventArgs* args); +} + +/// Receives `NewBrowserVersionAvailable` events. +[uuid(f9a2976e-d34e-44fc-adee-81b6b57ca914), object, pointer_default(unique)] +interface ICoreWebView2NewBrowserVersionAvailableEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. + + HRESULT Invoke([in] ICoreWebView2Environment* sender, + [in] IUnknown* args); +} + +/// Receives `BrowserProcessExited` events. +[uuid(fa504257-a216-4911-a860-fe8825712861), object, pointer_default(unique)] +interface ICoreWebView2BrowserProcessExitedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Environment* sender, + [in] ICoreWebView2BrowserProcessExitedEventArgs* args); +} + +/// Receives `ContainsFullScreenElementChanged` events. + +[uuid(e45d98b1-afef-45be-8baf-6c7728867f73), object, pointer_default(unique)] +interface ICoreWebView2ContainsFullScreenElementChangedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] IUnknown* args); +} + +/// Receives `WindowCloseRequested` events. +[uuid(5c19e9e0-092f-486b-affa-ca8231913039), object, pointer_default(unique)] +interface ICoreWebView2WindowCloseRequestedEventHandler : IUnknown { + + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + + HRESULT Invoke([in] ICoreWebView2* sender, [in] IUnknown* args); +} + +/// Receives `WebResourceResponseReceived` events. +[uuid(7DE9898A-24F5-40C3-A2DE-D4F458E69828), object, pointer_default(unique)] +interface ICoreWebView2WebResourceResponseReceivedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2WebResourceResponseReceivedEventArgs* args); +} + +/// Event args for the `BrowserProcessExited` event. +[uuid(1f00663f-af8c-4782-9cdd-dd01c52e34cb), object, pointer_default(unique)] +interface ICoreWebView2BrowserProcessExitedEventArgs : IUnknown { + /// The kind of browser process exit that has occurred. + [propget] HRESULT BrowserProcessExitKind( + [out, retval] COREWEBVIEW2_BROWSER_PROCESS_EXIT_KIND* browserProcessExitKind); + + /// The process ID of the browser process that has exited. + [propget] HRESULT BrowserProcessId([out, retval] UINT32* value); +} + +/// Event args for the WebResourceResponseReceived event. +[uuid(D1DB483D-6796-4B8B-80FC-13712BB716F4), object, pointer_default(unique)] +interface ICoreWebView2WebResourceResponseReceivedEventArgs : IUnknown { + /// The request object for the web resource, as committed. This includes + /// headers added by the network stack that were not be included during the + /// associated WebResourceRequested event, such as Authentication headers. + /// Modifications to this object have no effect on how the request is + /// processed as it has already been sent. + [propget] HRESULT Request([out, retval] ICoreWebView2WebResourceRequest** request); + /// View of the response object received for the web resource. + [propget] HRESULT Response([out, retval] ICoreWebView2WebResourceResponseView** response); +} + +/// View of the HTTP representation for a web resource response. The properties +/// of this object are not mutable. This response view is used with the +/// WebResourceResponseReceived event. +[uuid(79701053-7759-4162-8F7D-F1B3F084928D), object, pointer_default(unique)] +interface ICoreWebView2WebResourceResponseView : IUnknown { + /// The HTTP response headers as received. + [propget] HRESULT Headers( + [out, retval] ICoreWebView2HttpResponseHeaders** headers); + /// The HTTP response status code. + [propget] HRESULT StatusCode([out, retval] int* statusCode); + /// The HTTP response reason phrase. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT ReasonPhrase([out, retval] LPWSTR* reasonPhrase); + + /// Get the response content asynchronously. The handler will receive the + /// response content stream. + /// + /// This method returns null if content size is more than 123MB or for navigations that become downloads + /// or if response is downloadable content type (e.g., application/octet-stream). + /// See `add_DownloadStarting` event to handle the response. + /// + /// If this method is being called again before a first call has completed, + /// the handler will be invoked at the same time the handlers from prior calls + /// are invoked. + /// If this method is being called after a first call has completed, the + /// handler will be invoked immediately. + /// \snippet ScenarioWebViewEventMonitor.cpp GetContent + HRESULT GetContent( + [in] ICoreWebView2WebResourceResponseViewGetContentCompletedHandler* handler); +} + +/// Receives the result of the +/// `ICoreWebView2WebResourceResponseView::GetContent` method. +[uuid(875738E1-9FA2-40E3-8B74-2E8972DD6FE7), object, pointer_default(unique)] +interface ICoreWebView2WebResourceResponseViewGetContentCompletedHandler : IUnknown { + /// Provides the completion status and result of the corresponding + /// asynchronous method call. A failure `errorCode` will be passed if the + /// content failed to load. `E_ABORT` means the response loading was blocked + /// (e.g., by CORS policy); `ERROR_CANCELLED` means the response loading was + /// cancelled. `ERROR_NO_DATA` means the response has no content data, + /// `content` is `null` in this case. Note content (if any) is ignored for + /// redirects, 204 No Content, 205 Reset Content, and HEAD-request responses. + HRESULT Invoke([in] HRESULT errorCode, [in] IStream* content); +} + +/// Event args for the DOMContentLoaded event. +[uuid(16B1E21A-C503-44F2-84C9-70ABA5031283), object, pointer_default(unique)] +interface ICoreWebView2DOMContentLoadedEventArgs : IUnknown { + /// The ID of the navigation which corresponds to other navigation ID properties on other navigation events. + [propget] HRESULT NavigationId([out, retval] UINT64* navigationId); +} + +/// Receives `DOMContentLoaded` events. +[uuid(4BAC7E9C-199E-49ED-87ED-249303ACF019), object, pointer_default(unique)] +interface ICoreWebView2DOMContentLoadedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2DOMContentLoadedEventArgs* args); +} + +/// Provides a set of properties that are used to manage an +/// ICoreWebView2Cookie. +/// +/// \snippet ScenarioCookieManagement.cpp CookieObject +[uuid(AD26D6BE-1486-43E6-BF87-A2034006CA21), object, pointer_default(unique)] +interface ICoreWebView2Cookie : IUnknown { + /// Cookie name. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Name([out, retval] LPWSTR* name); + + /// Cookie value. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Value([out, retval] LPWSTR* value); + /// Set the cookie value property. + [propput] HRESULT Value([in] LPCWSTR value); + + /// The domain for which the cookie is valid. + /// The default is the host that this cookie has been received from. + /// Note that, for instance, ".bing.com", "bing.com", and "www.bing.com" are + /// considered different domains. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Domain([out, retval] LPWSTR* domain); + + /// The path for which the cookie is valid. The default is "/", which means + /// this cookie will be sent to all pages on the Domain. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Path([out, retval] LPWSTR* path); + + /// The expiration date and time for the cookie as the number of seconds since the UNIX epoch. + /// The default is -1.0, which means cookies are session cookies by default. + [propget] HRESULT Expires([out, retval] double* expires); + /// Set the Expires property. Cookies are session cookies and will not be + /// persistent if Expires is set to -1.0. NaN, infinity, and any negative + /// value set other than -1.0 is disallowed. + [propput] HRESULT Expires([in] double expires); + + /// Whether this cookie is http-only. + /// True if a page script or other active content cannot access this + /// cookie. The default is false. + [propget] HRESULT IsHttpOnly([out, retval] BOOL* isHttpOnly); + /// Set the IsHttpOnly property. + [propput] HRESULT IsHttpOnly([in] BOOL isHttpOnly); + + /// SameSite status of the cookie which represents the enforcement mode of the cookie. + /// The default is COREWEBVIEW2_COOKIE_SAME_SITE_KIND_LAX. + [propget] HRESULT SameSite([out, retval] COREWEBVIEW2_COOKIE_SAME_SITE_KIND* sameSite); + /// Set the SameSite property. + [propput] HRESULT SameSite([in] COREWEBVIEW2_COOKIE_SAME_SITE_KIND sameSite); + + /// The security level of this cookie. True if the client is only to return + /// the cookie in subsequent requests if those requests use HTTPS. + /// The default is false. + /// Note that cookie that requests COREWEBVIEW2_COOKIE_SAME_SITE_KIND_NONE but + /// is not marked Secure will be rejected. + [propget] HRESULT IsSecure([out, retval] BOOL* isSecure); + /// Set the IsSecure property. + [propput] HRESULT IsSecure([in] BOOL isSecure); + + /// Whether this is a session cookie. The default is false. + [propget] HRESULT IsSession([out, retval] BOOL* isSession); +} + +/// Creates, adds or updates, gets, or or view the cookies. The changes would +/// apply to the context of the user profile. That is, other WebViews under the +/// same user profile could be affected. +[uuid(177CD9E7-B6F5-451A-94A0-5D7A3A4C4141), object, pointer_default(unique)] +interface ICoreWebView2CookieManager : IUnknown { + /// Create a cookie object with a specified name, value, domain, and path. + /// One can set other optional properties after cookie creation. + /// This only creates a cookie object and it is not added to the cookie + /// manager until you call AddOrUpdateCookie. + /// Leading or trailing whitespace(s), empty string, and special characters + /// are not allowed for name. + /// See ICoreWebView2Cookie for more details. + HRESULT CreateCookie( + [in] LPCWSTR name, + [in] LPCWSTR value, + [in] LPCWSTR domain, + [in] LPCWSTR path, + [out, retval] ICoreWebView2Cookie** cookie); + + /// Creates a cookie whose params matches those of the specified cookie. + HRESULT CopyCookie( + [in] ICoreWebView2Cookie* cookieParam, + [out, retval] ICoreWebView2Cookie** cookie); + + /// Gets a list of cookies matching the specific URI. + /// If uri is empty string or null, all cookies under the same profile are + /// returned. + /// You can modify the cookie objects by calling + /// ICoreWebView2CookieManager::AddOrUpdateCookie, and the changes + /// will be applied to the webview. + /// \snippet ScenarioCookieManagement.cpp GetCookies + HRESULT GetCookies( + [in] LPCWSTR uri, + [in] ICoreWebView2GetCookiesCompletedHandler* handler); + + /// Adds or updates a cookie with the given cookie data; may overwrite + /// cookies with matching name, domain, and path if they exist. + /// This method will fail if the domain of the given cookie is not specified. + /// \snippet ScenarioCookieManagement.cpp AddOrUpdateCookie + HRESULT AddOrUpdateCookie([in] ICoreWebView2Cookie* cookie); + + /// Deletes a cookie whose name and domain/path pair + /// match those of the specified cookie. + HRESULT DeleteCookie([in] ICoreWebView2Cookie* cookie); + + /// Deletes cookies with matching name and uri. + /// Cookie name is required. + /// All cookies with the given name where domain + /// and path match provided URI are deleted. + HRESULT DeleteCookies([in] LPCWSTR name, [in] LPCWSTR uri); + + /// Deletes cookies with matching name and domain/path pair. + /// Cookie name is required. + /// If domain is specified, deletes only cookies with the exact domain. + /// If path is specified, deletes only cookies with the exact path. + HRESULT DeleteCookiesWithDomainAndPath([in] LPCWSTR name, [in] LPCWSTR domain, [in] LPCWSTR path); + + /// Deletes all cookies under the same profile. + /// This could affect other WebViews under the same user profile. + HRESULT DeleteAllCookies(); +} + +/// A list of cookie objects. See `ICoreWebView2Cookie`. +/// \snippet ScenarioCookieManagement.cpp GetCookies +[uuid(F7F6F714-5D2A-43C6-9503-346ECE02D186), object, pointer_default(unique)] +interface ICoreWebView2CookieList : IUnknown { + /// The number of cookies contained in the ICoreWebView2CookieList. + [propget] HRESULT Count([out, retval] UINT* count); + + /// Gets the cookie object at the given index. + HRESULT GetValueAtIndex([in] UINT index, [out, retval] ICoreWebView2Cookie** cookie); +} + +/// Receives the result of the `GetCookies` method. The result is written to +/// the cookie list provided in the `GetCookies` method call. +[uuid(5A4F5069-5C15-47C3-8646-F4DE1C116670), object, pointer_default(unique)] +interface ICoreWebView2GetCookiesCompletedHandler : IUnknown { + /// Provides the completion status of the corresponding asynchronous method + /// call. + HRESULT Invoke(HRESULT result, ICoreWebView2CookieList* cookieList); +} + +/// Provides access to the client certificate metadata. +[uuid(e7188076-bcc3-11eb-8529-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2ClientCertificate : IUnknown { + /// Subject of the certificate. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Subject([out, retval] LPWSTR* value); + /// Name of the certificate authority that issued the certificate. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Issuer([out, retval] LPWSTR* value); + /// The valid start date and time for the certificate as the number of seconds since + /// the UNIX epoch. + [propget] HRESULT ValidFrom([out, retval] double* value); + /// The valid expiration date and time for the certificate as the number of seconds since + /// the UNIX epoch. + [propget] HRESULT ValidTo([out, retval] double* value); + /// Base64 encoding of DER encoded serial number of the certificate. + /// Read more about DER at [RFC 7468 DER] + /// (https://tools.ietf.org/html/rfc7468#appendix-B). + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT DerEncodedSerialNumber([out, retval] LPWSTR* value); + /// Display name for a certificate. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT DisplayName([out, retval] LPWSTR* value); + /// PEM encoded data for the certificate. + /// Returns Base64 encoding of DER encoded certificate. + /// Read more about PEM at [RFC 1421 Privacy Enhanced Mail] + /// (https://tools.ietf.org/html/rfc1421). + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + HRESULT ToPemEncoding([out, retval] LPWSTR* pemEncodedData); + /// Collection of PEM encoded client certificate issuer chain. + /// In this collection first element is the current certificate followed by + /// intermediate1, intermediate2...intermediateN-1. Root certificate is the + /// last element in collection. + [propget] HRESULT PemEncodedIssuerCertificateChain([out, retval] + ICoreWebView2StringCollection** value); + /// Kind of a certificate (eg., smart card, pin, other). + [propget] HRESULT Kind([out, retval] + COREWEBVIEW2_CLIENT_CERTIFICATE_KIND* value); +} + +/// A collection of client certificate object. +[uuid(ef5674d2-bcc3-11eb-8529-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2ClientCertificateCollection : IUnknown { + /// The number of client certificates contained in the + /// ICoreWebView2ClientCertificateCollection. + [propget] HRESULT Count([out, retval] UINT* value); + /// Gets the certificate object at the given index. + HRESULT GetValueAtIndex([in] UINT index, + [out, retval] ICoreWebView2ClientCertificate** certificate); +} + +/// A collection of strings. +[uuid(f41f3f8a-bcc3-11eb-8529-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2StringCollection : IUnknown { + /// The number of strings contained in ICoreWebView2StringCollection. + [propget] HRESULT Count([out, retval] UINT* value); + + /// Gets the value at a given index. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + HRESULT GetValueAtIndex([in] UINT index, [out, retval] LPWSTR* value); +} + +/// An event handler for the `ClientCertificateRequested` event. +[uuid(d7175ba2-bcc3-11eb-8529-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2ClientCertificateRequestedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke([in] ICoreWebView2* sender, + [in] ICoreWebView2ClientCertificateRequestedEventArgs* args); +} + +/// Event args for the `ClientCertificateRequested` event. +[uuid(bc59db28-bcc3-11eb-8529-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2ClientCertificateRequestedEventArgs : IUnknown { + /// Host name of the server that requested client certificate authentication. + /// Normalization rules applied to the hostname are: + /// * Convert to lowercase characters for ascii characters. + /// * Punycode is used for representing non ascii characters. + /// * Strip square brackets for IPV6 address. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Host([out, retval] LPWSTR* value); + + /// Port of the server that requested client certificate authentication. + [propget] HRESULT Port([out, retval] int* value); + + /// Returns true if the server that issued this request is an http proxy. + /// Returns false if the server is the origin server. + [propget] HRESULT IsProxy([out, retval] BOOL* value); + + /// Returns the `ICoreWebView2StringCollection`. + /// The collection contains Base64 encoding of DER encoded distinguished names of + /// certificate authorities allowed by the server. + [propget] HRESULT AllowedCertificateAuthorities([out, retval] + ICoreWebView2StringCollection** value); + + /// Returns the `ICoreWebView2ClientCertificateCollection` when client + /// certificate authentication is requested. The collection contains mutually + /// trusted CA certificates. + [propget] HRESULT MutuallyTrustedCertificates([out, retval] + ICoreWebView2ClientCertificateCollection** value); + + /// Returns the selected certificate. + [propget] HRESULT SelectedCertificate([out, retval] + ICoreWebView2ClientCertificate** value); + + /// Sets the certificate to respond to the server. + [propput] HRESULT SelectedCertificate( + [in] ICoreWebView2ClientCertificate* value); + + /// You may set this flag to cancel the certificate selection. If canceled, + /// the request is aborted regardless of the `Handled` property. By default the + /// value is `FALSE`. + [propget] HRESULT Cancel([out, retval] BOOL* value); + + /// Sets the `Cancel` property. + [propput] HRESULT Cancel([in] BOOL value); + + /// You may set this flag to `TRUE` to respond to the server with or + /// without a certificate. If this flag is `TRUE` with a `SelectedCertificate` + /// it responds to the server with the selected certificate otherwise respond to the + /// server without a certificate. By default the value of `Handled` and `Cancel` are `FALSE` + /// and display default client certificate selection dialog prompt to allow the user to + /// choose a certificate. The `SelectedCertificate` is ignored unless `Handled` is set `TRUE`. + [propget] HRESULT Handled([out, retval] BOOL* value); + + /// Sets the `Handled` property. + [propput] HRESULT Handled([in] BOOL value); + + /// Returns an `ICoreWebView2Deferral` object. Use this operation to + /// complete the event at a later time. + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); +} + +/// This mostly represents a combined win32 +/// POINTER_INFO/POINTER_TOUCH_INFO/POINTER_PEN_INFO object. It takes fields +/// from all three and excludes some win32 specific data types like HWND and +/// HANDLE. Note, sourceDevice is taken out but we expect the PointerDeviceRect +/// and DisplayRect to cover the existing use cases of sourceDevice. +/// Another big difference is that any of the point or rect locations are +/// expected to be in WebView physical coordinates. That is, coordinates +/// relative to the WebView and no DPI scaling applied. +// +// The PointerId, PointerFlags, ButtonChangeKind, PenFlags, PenMask, TouchFlags, +// and TouchMask are all #defined flags or enums in the +// POINTER_INFO/POINTER_TOUCH_INFO/POINTER_PEN_INFO structure. We define those +// properties here as UINT32 or INT32 and expect the developer to know how to +// populate those values based on the Windows definitions. +[uuid(e6995887-d10d-4f5d-9359-4ce46e4f96b9), object, pointer_default(unique)] +interface ICoreWebView2PointerInfo : IUnknown { + /// Get the PointerKind of the pointer event. This corresponds to the + /// pointerKind property of the POINTER_INFO struct. The values are defined by + /// the POINTER_INPUT_KIND enum in the Windows SDK (winuser.h). Supports + /// PT_PEN and PT_TOUCH. + [propget] HRESULT PointerKind([out, retval] DWORD* pointerKind); + /// Set the PointerKind of the pointer event. This corresponds to the + /// pointerKind property of the POINTER_INFO struct. The values are defined by + /// the POINTER_INPUT_KIND enum in the Windows SDK (winuser.h). Supports + /// PT_PEN and PT_TOUCH. + [propput] HRESULT PointerKind([in] DWORD pointerKind); + + /// Get the PointerId of the pointer event. This corresponds to the pointerId + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT PointerId([out, retval] UINT32* pointerId); + /// Set the PointerId of the pointer event. This corresponds to the pointerId + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT PointerId([in] UINT32 pointerId); + + /// Get the FrameID of the pointer event. This corresponds to the frameId + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT FrameId([out, retval] UINT32* frameId); + /// Set the FrameID of the pointer event. This corresponds to the frameId + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT FrameId([in] UINT32 frameId); + + /// Get the PointerFlags of the pointer event. This corresponds to the + /// pointerFlags property of the POINTER_INFO struct. The values are defined + /// by the POINTER_FLAGS constants in the Windows SDK (winuser.h). + [propget] HRESULT PointerFlags([out, retval] UINT32* pointerFlags); + /// Set the PointerFlags of the pointer event. This corresponds to the + /// pointerFlags property of the POINTER_INFO struct. The values are defined + /// by the POINTER_FLAGS constants in the Windows SDK (winuser.h). + [propput] HRESULT PointerFlags([in] UINT32 pointerFlags); + + /// Get the PointerDeviceRect of the sourceDevice property of the + /// POINTER_INFO struct as defined in the Windows SDK (winuser.h). + [propget] HRESULT PointerDeviceRect([out, retval] RECT* pointerDeviceRect); + /// Set the PointerDeviceRect of the sourceDevice property of the + /// POINTER_INFO struct as defined in the Windows SDK (winuser.h). + [propput] HRESULT PointerDeviceRect([in] RECT pointerDeviceRect); + + /// Get the DisplayRect of the sourceDevice property of the POINTER_INFO + /// struct as defined in the Windows SDK (winuser.h). + [propget] HRESULT DisplayRect([out, retval] RECT* displayRect); + /// Set the DisplayRect of the sourceDevice property of the POINTER_INFO + /// struct as defined in the Windows SDK (winuser.h). + [propput] HRESULT DisplayRect([in] RECT displayRect); + + /// Get the PixelLocation of the pointer event. This corresponds to the + /// ptPixelLocation property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT PixelLocation([out, retval] POINT* pixelLocation); + /// Set the PixelLocation of the pointer event. This corresponds to the + /// ptPixelLocation property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT PixelLocation([in] POINT pixelLocation); + + /// Get the HimetricLocation of the pointer event. This corresponds to the + /// ptHimetricLocation property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT HimetricLocation([out, retval] POINT* himetricLocation); + /// Set the HimetricLocation of the pointer event. This corresponds to the + /// ptHimetricLocation property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT HimetricLocation([in] POINT himetricLocation); + + /// Get the PixelLocationRaw of the pointer event. This corresponds to the + /// ptPixelLocationRaw property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT PixelLocationRaw([out, retval] POINT* pixelLocationRaw); + /// Set the PixelLocationRaw of the pointer event. This corresponds to the + /// ptPixelLocationRaw property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT PixelLocationRaw([in] POINT pixelLocationRaw); + + /// Get the HimetricLocationRaw of the pointer event. This corresponds to the + /// ptHimetricLocationRaw property of the POINTER_INFO struct as defined in + /// the Windows SDK (winuser.h). + [propget] HRESULT HimetricLocationRaw([out, retval] POINT* himetricLocationRaw); + /// Set the HimetricLocationRaw of the pointer event. This corresponds to the + /// ptHimetricLocationRaw property of the POINTER_INFO struct as defined in + /// the Windows SDK (winuser.h). + [propput] HRESULT HimetricLocationRaw([in] POINT himetricLocationRaw); + + /// Get the Time of the pointer event. This corresponds to the dwTime property + /// of the POINTER_INFO struct as defined in the Windows SDK (winuser.h). + [propget] HRESULT Time([out, retval] DWORD* time); + /// Set the Time of the pointer event. This corresponds to the dwTime property + /// of the POINTER_INFO struct as defined in the Windows SDK (winuser.h). + [propput] HRESULT Time([in] DWORD time); + + /// Get the HistoryCount of the pointer event. This corresponds to the + /// historyCount property of the POINTER_INFO struct as defined in the Windows + /// SDK (winuser.h). + [propget] HRESULT HistoryCount([out, retval] UINT32* historyCount); + /// Set the HistoryCount of the pointer event. This corresponds to the + /// historyCount property of the POINTER_INFO struct as defined in the Windows + /// SDK (winuser.h). + [propput] HRESULT HistoryCount([in] UINT32 historyCount); + + /// Get the InputData of the pointer event. This corresponds to the InputData + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT InputData([out, retval] INT32* inputData); + /// Set the InputData of the pointer event. This corresponds to the InputData + /// property of the POINTER_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT InputData([in] INT32 inputData); + + /// Get the KeyStates of the pointer event. This corresponds to the + /// dwKeyStates property of the POINTER_INFO struct as defined in the Windows + /// SDK (winuser.h). + [propget] HRESULT KeyStates([out, retval] DWORD* keyStates); + /// Set the KeyStates of the pointer event. This corresponds to the + /// dwKeyStates property of the POINTER_INFO struct as defined in the Windows + /// SDK (winuser.h). + [propput] HRESULT KeyStates([in] DWORD keyStates); + + /// Get the PerformanceCount of the pointer event. This corresponds to the + /// PerformanceCount property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT PerformanceCount([out, retval] UINT64* performanceCount); + /// Set the PerformanceCount of the pointer event. This corresponds to the + /// PerformanceCount property of the POINTER_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT PerformanceCount([in] UINT64 performanceCount); + + /// Get the ButtonChangeKind of the pointer event. This corresponds to the + /// ButtonChangeKind property of the POINTER_INFO struct. The values are + /// defined by the POINTER_BUTTON_CHANGE_KIND enum in the Windows SDK + /// (winuser.h). + [propget] HRESULT ButtonChangeKind([out, retval] INT32* buttonChangeKind); + /// Set the ButtonChangeKind of the pointer event. This corresponds to the + /// ButtonChangeKind property of the POINTER_INFO struct. The values are + /// defined by the POINTER_BUTTON_CHANGE_KIND enum in the Windows SDK + /// (winuser.h). + [propput] HRESULT ButtonChangeKind([in] INT32 buttonChangeKind); + + // Pen specific attributes + + /// Get the PenFlags of the pointer event. This corresponds to the penFlags + /// property of the POINTER_PEN_INFO struct. The values are defined by the + /// PEN_FLAGS constants in the Windows SDK (winuser.h). + [propget] HRESULT PenFlags([out, retval] UINT32* penFLags); + /// Set the PenFlags of the pointer event. This corresponds to the penFlags + /// property of the POINTER_PEN_INFO struct. The values are defined by the + /// PEN_FLAGS constants in the Windows SDK (winuser.h). + [propput] HRESULT PenFlags([in] UINT32 penFLags); + + /// Get the PenMask of the pointer event. This corresponds to the penMask + /// property of the POINTER_PEN_INFO struct. The values are defined by the + /// PEN_MASK constants in the Windows SDK (winuser.h). + [propget] HRESULT PenMask([out, retval] UINT32* penMask); + /// Set the PenMask of the pointer event. This corresponds to the penMask + /// property of the POINTER_PEN_INFO struct. The values are defined by the + /// PEN_MASK constants in the Windows SDK (winuser.h). + [propput] HRESULT PenMask([in] UINT32 penMask); + + /// Get the PenPressure of the pointer event. This corresponds to the pressure + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT PenPressure([out, retval] UINT32* penPressure); + /// Set the PenPressure of the pointer event. This corresponds to the pressure + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT PenPressure([in] UINT32 penPressure); + + /// Get the PenRotation of the pointer event. This corresponds to the rotation + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT PenRotation([out, retval] UINT32* penRotation); + /// Set the PenRotation of the pointer event. This corresponds to the rotation + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT PenRotation([in] UINT32 penRotation); + + /// Get the PenTiltX of the pointer event. This corresponds to the tiltX + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT PenTiltX([out, retval] INT32* penTiltX); + /// Set the PenTiltX of the pointer event. This corresponds to the tiltX + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT PenTiltX([in] INT32 penTiltX); + + /// Get the PenTiltY of the pointer event. This corresponds to the tiltY + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propget] HRESULT PenTiltY([out, retval] INT32* penTiltY); + /// Set the PenTiltY of the pointer event. This corresponds to the tiltY + /// property of the POINTER_PEN_INFO struct as defined in the Windows SDK + /// (winuser.h). + [propput] HRESULT PenTiltY([in] INT32 penTiltY); + + // Touch specific attributes + + /// Get the TouchFlags of the pointer event. This corresponds to the + /// touchFlags property of the POINTER_TOUCH_INFO struct. The values are + /// defined by the TOUCH_FLAGS constants in the Windows SDK (winuser.h). + [propget] HRESULT TouchFlags([out, retval] UINT32* touchFlags); + /// Set the TouchFlags of the pointer event. This corresponds to the + /// touchFlags property of the POINTER_TOUCH_INFO struct. The values are + /// defined by the TOUCH_FLAGS constants in the Windows SDK (winuser.h). + [propput] HRESULT TouchFlags([in] UINT32 touchFlags); + + /// Get the TouchMask of the pointer event. This corresponds to the + /// touchMask property of the POINTER_TOUCH_INFO struct. The values are + /// defined by the TOUCH_MASK constants in the Windows SDK (winuser.h). + [propget] HRESULT TouchMask([out, retval] UINT32* touchMask); + /// Set the TouchMask of the pointer event. This corresponds to the + /// touchMask property of the POINTER_TOUCH_INFO struct. The values are + /// defined by the TOUCH_MASK constants in the Windows SDK (winuser.h). + [propput] HRESULT TouchMask([in] UINT32 touchMask); + + /// Get the TouchContact of the pointer event. This corresponds to the + /// rcContact property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT TouchContact([out, retval] RECT* touchContact); + /// Set the TouchContact of the pointer event. This corresponds to the + /// rcContact property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT TouchContact([in] RECT touchContact); + + /// Get the TouchContactRaw of the pointer event. This corresponds to the + /// rcContactRaw property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT TouchContactRaw([out, retval] RECT* touchContactRaw); + /// Set the TouchContactRaw of the pointer event. This corresponds to the + /// rcContactRaw property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT TouchContactRaw([in] RECT touchContactRaw); + + /// Get the TouchOrientation of the pointer event. This corresponds to the + /// orientation property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT TouchOrientation([out, retval] UINT32* touchOrientation); + /// Set the TouchOrientation of the pointer event. This corresponds to the + /// orientation property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT TouchOrientation([in] UINT32 touchOrientation); + + /// Get the TouchPressure of the pointer event. This corresponds to the + /// pressure property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propget] HRESULT TouchPressure([out, retval] UINT32* touchPressure); + /// Set the TouchPressure of the pointer event. This corresponds to the + /// pressure property of the POINTER_TOUCH_INFO struct as defined in the + /// Windows SDK (winuser.h). + [propput] HRESULT TouchPressure([in] UINT32 touchPressure); +} + +/// The caller implements this interface to receive CursorChanged events. Use +/// the Cursor property to get the new cursor. +[uuid(9da43ccc-26e1-4dad-b56c-d8961c94c571), object, pointer_default(unique)] +interface ICoreWebView2CursorChangedEventHandler : IUnknown { + /// Called to provide the implementer with the event args for the + /// corresponding event. There are no event args and the args + /// parameter will be null. + HRESULT Invoke([in] ICoreWebView2CompositionController* sender, [in] IUnknown* args); +} + +/// Receives `RasterizationScaleChanged` events. Use the `RasterizationScale` +/// property to get the modified scale. + +[uuid(9c98c8b1-ac53-427e-a345-3049b5524bbe), object, pointer_default(unique)] +interface ICoreWebView2RasterizationScaleChangedEventHandler : IUnknown { + /// Called to provide the implementer with the event args for the + /// corresponding event. There are no event args and the args + /// parameter will be null. + HRESULT Invoke( + [in] ICoreWebView2Controller* sender, + [in] IUnknown* args); +} + +/// Represents the WebView2 Environment. WebViews created from an environment +/// run on the browser process specified with environment parameters and +/// objects created from an environment should be used in the same +/// environment. Using it in different environments are not guaranteed to be +/// compatible and may fail. + +[uuid(b96d755e-0319-4e92-a296-23436f46a1fc), object, pointer_default(unique)] +interface ICoreWebView2Environment : IUnknown { + + /// Asynchronously create a new WebView. + /// + /// `parentWindow` is the `HWND` in which the WebView should be displayed and + /// from which receive input. The WebView adds a child window to the + /// provided window before this function returns. Z-order and other things + /// impacted by sibling window order are affected accordingly. If you want to + /// move the WebView to a different parent after it has been created, you must + /// call put_ParentWindow to update tooltip positions, accessibility trees, + /// and such. + /// + /// HWND_MESSAGE is a valid parameter for `parentWindow` for an invisible + /// WebView for Windows 8 and above. In this case the window will never + /// become visible. You are not able to reparent the window after you have + /// created the WebView. This is not supported in Windows 7 or below. + /// Passing this parameter in Windows 7 or below will return + /// ERROR_INVALID_WINDOW_HANDLE in the controller callback. + /// + /// It is recommended that the app set Application User Model ID for the + /// process or the app window. If none is set, during WebView creation a + /// generated Application User Model ID is set to root window of + /// `parentWindow`. + /// + /// \snippet AppWindow.cpp CreateCoreWebView2Controller + /// + /// It is recommended that the app handles restart manager messages, to + /// gracefully restart it in the case when the app is using the WebView2 + /// Runtime from a certain installation and that installation is being + /// uninstalled. For example, if a user installs a version of the WebView2 + /// Runtime and opts to use another version of the WebView2 Runtime for + /// testing the app, and then uninstalls the 1st version of the WebView2 + /// Runtime without closing the app, the app restarts to allow + /// un-installation to succeed. + /// + /// \snippet AppWindow.cpp RestartManager + /// + /// The app should retry `CreateCoreWebView2Controller` upon failure, unless the + /// error code is `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`. + /// When the app retries `CreateCoreWebView2Controller` upon failure, it is + /// recommended that the app restarts from creating a new WebView2 + /// Environment. If a WebView2 Runtime update happens, the version + /// associated with a WebView2 Environment may have been removed and causing + /// the object to no longer work. Creating a new WebView2 Environment works + /// since it uses the latest version. + /// + /// WebView creation fails with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)` if a + /// running instance using the same user data folder exists, and the Environment + /// objects have different `EnvironmentOptions`. For example, if a WebView was + /// created with one language, an attempt to create a WebView with a different + /// language using the same user data folder will fail. + /// + /// The creation will fail with `E_ABORT` if `parentWindow` is destroyed + /// before the creation is finished. If this is caused by a call to + /// `DestroyWindow`, the creation completed handler will be invoked before + /// `DestroyWindow` returns, so you can use this to cancel creation and clean + /// up resources synchronously when quitting a thread. + /// + /// In rare cases the creation can fail with `E_UNEXPECTED` if runtime does not have + /// permissions to the user data folder. + + HRESULT CreateCoreWebView2Controller( + HWND parentWindow, + ICoreWebView2CreateCoreWebView2ControllerCompletedHandler* handler); + + /// Create a new web resource response object. The `headers` parameter is + /// the raw response header string delimited by newline. It is also possible + /// to create this object with null headers string and then use the + /// `ICoreWebView2HttpResponseHeaders` to construct the headers line by line. + /// For more information about other parameters, navigate to + /// [ICoreWebView2WebResourceResponse](/microsoft-edge/webview2/reference/win32/icorewebview2webresourceresponse). + /// + /// \snippet SettingsComponent.cpp WebResourceRequested0 + /// \snippet SettingsComponent.cpp WebResourceRequested1 + HRESULT CreateWebResourceResponse( + [in] IStream* content, + [in] int statusCode, + [in] LPCWSTR reasonPhrase, + [in] LPCWSTR headers, + [out, retval] ICoreWebView2WebResourceResponse** response); + + /// The browser version info of the current `ICoreWebView2Environment`, + /// including channel name if it is not the WebView2 Runtime. It matches the + /// format of the `GetAvailableCoreWebView2BrowserVersionString` API. + /// Channel names are `beta`, `dev`, and `canary`. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + /// + /// \snippet AppWindow.cpp GetBrowserVersionString + [propget] HRESULT BrowserVersionString([out, retval] LPWSTR* versionInfo); + + /// Add an event handler for the `NewBrowserVersionAvailable` event. + /// `NewBrowserVersionAvailable` runs when a newer version of the WebView2 + /// Runtime is installed and available using WebView2. To use the newer + /// version of the browser you must create a new environment and WebView. + /// The event only runs for new version from the same WebView2 Runtime from + /// which the code is running. When not running with installed WebView2 + /// Runtime, no event is run. + /// + /// Because a user data folder is only able to be used by one browser + /// process at a time, if you want to use the same user data folder in the + /// WebView using the new version of the browser, you must close the + /// environment and instance of WebView that are using the older version of + /// the browser first. Or simply prompt the user to restart the app. + /// + /// \snippet AppWindow.cpp NewBrowserVersionAvailable + HRESULT add_NewBrowserVersionAvailable( + [in] ICoreWebView2NewBrowserVersionAvailableEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NewBrowserVersionAvailable`. + HRESULT remove_NewBrowserVersionAvailable( + [in] EventRegistrationToken token); +} + +/// A continuation of the ICoreWebView2Environment interface. +[uuid(41F3632B-5EF4-404F-AD82-2D606C5A9A21), object, pointer_default(unique)] +interface ICoreWebView2Environment2 : ICoreWebView2Environment { + /// Create a new web resource request object. + /// URI parameter must be absolute URI. + /// The headers string is the raw request header string delimited by CRLF + /// (optional in last header). + /// It's also possible to create this object with null headers string + /// and then use the ICoreWebView2HttpRequestHeaders to construct the headers + /// line by line. + /// For information on other parameters see ICoreWebView2WebResourceRequest. + /// + /// \snippet ScenarioNavigateWithWebResourceRequest.cpp NavigateWithWebResourceRequest + HRESULT CreateWebResourceRequest([in] LPCWSTR uri, + [in] LPCWSTR method, + [in] IStream* postData, + [in] LPCWSTR headers, + [out, retval] ICoreWebView2WebResourceRequest** request); +} + +/// A continuation of the ICoreWebView2Environment2 interface. +[uuid(80a22ae3-be7c-4ce2-afe1-5a50056cdeeb), object, pointer_default(unique)] +interface ICoreWebView2Environment3 : ICoreWebView2Environment2 { + /// Asynchronously create a new WebView for use with visual hosting. + /// + /// parentWindow is the HWND in which the app will connect the visual tree of + /// the WebView. This will be the HWND that the app will receive pointer/ + /// mouse input meant for the WebView (and will need to use SendMouseInput/ + /// SendPointerInput to forward). If the app moves the WebView visual tree to + /// underneath a different window, then it needs to call put_ParentWindow to + /// update the new parent HWND of the visual tree. + /// + /// HWND_MESSAGE is not a valid parameter for `parentWindow` for visual hosting. + /// The underlying implementation of supporting HWND_MESSAGE would break + /// accessibility for visual hosting. This is supported in windowed + /// WebViews - see CreateCoreWebView2Controller. + /// + /// Use put_RootVisualTarget on the created CoreWebView2CompositionController to + /// provide a visual to host the browser's visual tree. + /// + /// It is recommended that the application set Application User Model ID for + /// the process or the application window. If none is set, during WebView + /// creation a generated Application User Model ID is set to root window of + /// parentWindow. + /// \snippet AppWindow.cpp CreateCoreWebView2Controller + /// + /// It is recommended that the application handles restart manager messages + /// so that it can be restarted gracefully in the case when the app is using + /// Edge for WebView from a certain installation and that installation is + /// being uninstalled. For example, if a user installs Edge from Dev channel + /// and opts to use Edge from that channel for testing the app, and then + /// uninstalls Edge from that channel without closing the app, the app will + /// be restarted to allow uninstallation of the dev channel to succeed. + /// \snippet AppWindow.cpp RestartManager + /// + /// The app should retry `CreateCoreWebView2CompositionController` upon failure, + /// unless the error code is `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`. + /// When the app retries `CreateCoreWebView2CompositionController` + /// upon failure, it is recommended that the app restarts from creating a new + /// WebView2 Environment. If a WebView2 Runtime update happens, the version + /// associated with a WebView2 Environment may have been removed and causing + /// the object to no longer work. Creating a new WebView2 Environment works + /// since it uses the latest version. + /// + /// WebView creation fails with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)` if a + /// running instance using the same user data folder exists, and the Environment + /// objects have different `EnvironmentOptions`. For example, if a WebView was + /// created with one language, an attempt to create a WebView with a different + /// language using the same user data folder will fail. + /// + /// The creation will fail with `E_ABORT` if `parentWindow` is destroyed + /// before the creation is finished. If this is caused by a call to + /// `DestroyWindow`, the creation completed handler will be invoked before + /// `DestroyWindow` returns, so you can use this to cancel creation and clean + /// up resources synchronously when quitting a thread. + /// + /// In rare cases the creation can fail with `E_UNEXPECTED` if runtime does not have + /// permissions to the user data folder. + /// + /// CreateCoreWebView2CompositionController is supported in the following versions of Windows: + /// + /// - Windows 11 + /// - Windows 10 + /// - Windows Server 2019 + /// - Windows Server 2016 + /// + HRESULT CreateCoreWebView2CompositionController( + HWND parentWindow, + ICoreWebView2CreateCoreWebView2CompositionControllerCompletedHandler* handler); + + /// Create an empty ICoreWebView2PointerInfo. The returned + /// ICoreWebView2PointerInfo needs to be populated with all of the relevant + /// info before calling SendPointerInput. + HRESULT CreateCoreWebView2PointerInfo( + [out, retval] ICoreWebView2PointerInfo** pointerInfo); +} + +/// A continuation of the ICoreWebView2Environment3 interface. +[uuid(20944379-6dcf-41d6-a0a0-abc0fc50de0d), object, pointer_default(unique)] +interface ICoreWebView2Environment4 : ICoreWebView2Environment3 { + /// Returns the Automation Provider for the WebView that matches the provided + /// window. Host apps are expected to implement + /// IRawElementProviderHwndOverride. When GetOverrideProviderForHwnd is + /// called, the app can pass the HWND to GetAutomationProviderForWindow to + /// find the matching WebView Automation Provider. + HRESULT GetAutomationProviderForWindow([in] HWND hwnd, + [out, retval] IUnknown** provider); +} + +/// A continuation of the `ICoreWebView2Environment4` interface that supports +/// the `BrowserProcessExited` event. +[uuid(319e423d-e0d7-4b8d-9254-ae9475de9b17), object, pointer_default(unique)] +interface ICoreWebView2Environment5 : ICoreWebView2Environment4 { + /// Add an event handler for the `BrowserProcessExited` event. + /// The `BrowserProcessExited` event is raised when the collection of WebView2 + /// Runtime processes for the browser process of this environment terminate + /// due to browser process failure or normal shutdown (for example, when all + /// associated WebViews are closed), after all resources have been released + /// (including the user data folder). To learn about what these processes are, + /// go to [Process model](/microsoft-edge/webview2/concepts/process-model). + /// + /// A handler added with this method is called until removed with + /// `remove_BrowserProcessExited`, even if a new browser process is bound to + /// this environment after earlier `BrowserProcessExited` events are raised. + /// + /// Multiple app processes can share a browser process by creating their webviews + /// from a `ICoreWebView2Environment` with the same user data folder. When the entire + /// collection of WebView2Runtime processes for the browser process exit, all + /// associated `ICoreWebView2Environment` objects receive the `BrowserProcessExited` + /// event. Multiple processes sharing the same browser process need to coordinate + /// their use of the shared user data folder to avoid race conditions and + /// unnecessary waits. For example, one process should not clear the user data + /// folder at the same time that another process recovers from a crash by recreating + /// its WebView controls; one process should not block waiting for the event if + /// other app processes are using the same browser process (the browser process will + /// not exit until those other processes have closed their webviews too). + /// + /// Note this is an event from the `ICoreWebView2Environment3` interface, not + /// the `ICoreWebView2` one. The difference between `BrowserProcessExited` and + /// `ICoreWebView2`'s `ProcessFailed` is that `BrowserProcessExited` is + /// raised for any **browser process** exit (expected or unexpected, after all + /// associated processes have exited too), while `ProcessFailed` is raised for + /// **unexpected** process exits of any kind (browser, render, GPU, and all + /// other types), or for main frame **render process** unresponsiveness. To + /// learn more about the WebView2 Process Model, go to + /// [Process model](/microsoft-edge/webview2/concepts/process-model). + /// + /// In the case the browser process crashes, both `BrowserProcessExited` and + /// `ProcessFailed` events are raised, but the order is not guaranteed. These + /// events are intended for different scenarios. It is up to the app to + /// coordinate the handlers so they do not try to perform reliability recovery + /// while also trying to move to a new WebView2 Runtime version or remove the + /// user data folder. + /// + /// \snippet AppWindow.cpp Close + HRESULT add_BrowserProcessExited( + [in] ICoreWebView2BrowserProcessExitedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_BrowserProcessExited`. + HRESULT remove_BrowserProcessExited([in] EventRegistrationToken token); +} + +/// This interface is an extension of the ICoreWebView2Environment that supports +/// creating print settings for printing to PDF. +[uuid(e59ee362-acbd-4857-9a8e-d3644d9459a9), object, pointer_default(unique)] +interface ICoreWebView2Environment6 : ICoreWebView2Environment5 { + /// Creates the `ICoreWebView2PrintSettings` used by the `PrintToPdf` + /// method. + HRESULT CreatePrintSettings( + [out, retval] ICoreWebView2PrintSettings** printSettings); +} + +/// This interface is an extension of the ICoreWebView2Environment. An object +/// implementing the ICoreWebView2Environment7 interface will also +/// implement ICoreWebView2Environment. +[uuid(43C22296-3BBD-43A4-9C00-5C0DF6DD29A2), object, pointer_default(unique)] +interface ICoreWebView2Environment7 : ICoreWebView2Environment6 { + /// Returns the user data folder that all CoreWebView2's created from this + /// environment are using. + /// This could be either the value passed in by the developer when creating + /// the environment object or the calculated one for default handling. It + /// will always be an absolute path. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + /// + /// \snippet AppWindow.cpp GetUserDataFolder + [propget] HRESULT UserDataFolder([ out, retval ] LPWSTR * value); +} + +/// A continuation of the `ICoreWebView2Environment7` interface that supports +/// the `ProcessInfosChanged` event. +[uuid(D6EB91DD-C3D2-45E5-BD29-6DC2BC4DE9CF), object, pointer_default(unique)] +interface ICoreWebView2Environment8 : ICoreWebView2Environment7 { + /// Adds an event handler for the `ProcessInfosChanged` event. + /// + /// \snippet ProcessComponent.cpp ProcessInfosChanged + /// \snippet ProcessComponent.cpp ProcessInfosChanged1 + HRESULT add_ProcessInfosChanged( + [in] ICoreWebView2ProcessInfosChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ProcessInfosChanged`. + HRESULT remove_ProcessInfosChanged( + [in] EventRegistrationToken token); + + /// Returns the `ICoreWebView2ProcessInfoCollection` + /// Provide a list of all process using same user data folder except for crashpad process. + HRESULT GetProcessInfos([out, retval]ICoreWebView2ProcessInfoCollection** value); +} + +/// Provides a set of properties for a process in the `ICoreWebView2Environment`. +[uuid(84FA7612-3F3D-4FBF-889D-FAD000492D72), object, pointer_default(unique)] +interface ICoreWebView2ProcessInfo : IUnknown { + + /// The process id of the process. + [propget] HRESULT ProcessId([out, retval] INT32* value); + + /// The kind of the process. + [propget] HRESULT Kind([out, retval] COREWEBVIEW2_PROCESS_KIND* kind); +} + +/// A continuation of the ICoreWebView2Environment interface for +/// creating CoreWebView2 ContextMenuItem objects. +[uuid(f06f41bf-4b5a-49d8-b9f6-fa16cd29f274), object, pointer_default(unique)] +interface ICoreWebView2Environment9 : ICoreWebView2Environment8 { + /// Create a custom `ContextMenuItem` object to insert into the WebView context menu. + /// CoreWebView2 will rewind the icon stream before decoding. + /// There is a limit of 1000 active custom context menu items at a given time. + /// Attempting to create more before deleting existing ones will fail with + /// ERROR_NOT_ENOUGH_QUOTA. + /// It is recommended to reuse ContextMenuItems across ContextMenuRequested events + /// for performance. + /// The returned ContextMenuItem object's `IsEnabled` property will default to `TRUE` + /// and `IsChecked` property will default to `FALSE`. A `CommandId` will be assigned + /// to the ContextMenuItem object that's unique across active custom context menu items, + /// but command ID values of deleted ContextMenuItems can be reassigned. + HRESULT CreateContextMenuItem( + [in] LPCWSTR label, + [in] IStream* iconStream, + [in] COREWEBVIEW2_CONTEXT_MENU_ITEM_KIND kind, + [out, retval] ICoreWebView2ContextMenuItem** item); +} + +/// This interface is used to create `ICoreWebView2ControllerOptions` object, which +/// can be passed as a parameter in `CreateCoreWebView2ControllerWithOptions` and +/// `CreateCoreWebView2CompositionControllerWithOptions` function for multiple profiles support. +/// The profile will be created on disk or opened when calling `CreateCoreWebView2ControllerWithOptions` or +/// `CreateCoreWebView2CompositionControllerWithOptions` no matter InPrivate mode is enabled or not, and +/// it will be released in memory when the corresponding controller is closed but still remain on disk. +/// If you create a WebView2Controller with {ProfileName="name", InPrivate=false} and then later create another +/// one with {ProfileName="name", InPrivate=true}, these two controllers using the same profile would be allowed to +/// run at the same time. +/// As WebView2 is built on top of Edge browser, it follows Edge's behavior pattern. To create an InPrivate WebView, +/// we gets an off-the-record profile (an InPrivate profile) from a regular profile, then create the WebView with the +/// off-the-record profile. +/// +/// \snippet AppWindow.cpp CreateControllerWithOptions +[uuid(ee0eb9df-6f12-46ce-b53f-3f47b9c928e0), object, pointer_default(unique)] +interface ICoreWebView2Environment10 : ICoreWebView2Environment9 { + /// Create a new ICoreWebView2ControllerOptions to be passed as a parameter of + /// CreateCoreWebView2ControllerWithOptions and CreateCoreWebView2CompositionControllerWithOptions. + /// The 'options' is settable and in it the default value for profile name is the empty string, + /// and the default value for IsInPrivateModeEnabled is false. + /// Also the profile name can be reused. + HRESULT CreateCoreWebView2ControllerOptions( + [out, retval] ICoreWebView2ControllerOptions** options); + + /// Create a new WebView with options. + HRESULT CreateCoreWebView2ControllerWithOptions( + [in] HWND parentWindow, + [in] ICoreWebView2ControllerOptions* options, + [in] ICoreWebView2CreateCoreWebView2ControllerCompletedHandler* handler); + + /// Create a new WebView in visual hosting mode with options. + HRESULT CreateCoreWebView2CompositionControllerWithOptions( + [in] HWND parentWindow, + [in] ICoreWebView2ControllerOptions* options, + [in] ICoreWebView2CreateCoreWebView2CompositionControllerCompletedHandler* handler); +} + +/// A list containing process id and corresponding process type. +[uuid(402B99CD-A0CC-4FA5-B7A5-51D86A1D2339), object, pointer_default(unique)] +interface ICoreWebView2ProcessInfoCollection : IUnknown { + /// The number of process contained in the ICoreWebView2ProcessInfoCollection. + [propget] HRESULT Count([out, retval] UINT* count); + + /// Gets the `ICoreWebView2ProcessInfo` located in the `ICoreWebView2ProcessInfoCollection` + /// at the given index. + HRESULT GetValueAtIndex([in] UINT32 index, + [out, retval] ICoreWebView2ProcessInfo** processInfo); +} + +/// An event handler for the `ProcessInfosChanged` event. +[uuid(F4AF0C39-44B9-40E9-8B11-0484CFB9E0A1), object, pointer_default(unique)] +interface ICoreWebView2ProcessInfosChangedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + HRESULT Invoke([in] ICoreWebView2Environment* sender, [in] IUnknown* args); +} + +/// Options used to create WebView2 Environment. A default implementation is +/// provided in `WebView2EnvironmentOptions.h`. +/// +/// \snippet AppWindow.cpp CreateCoreWebView2EnvironmentWithOptions + +[uuid(2fde08a8-1e9a-4766-8c05-95a9ceb9d1c5), object, pointer_default(unique)] +interface ICoreWebView2EnvironmentOptions : IUnknown { + + /// Changes the behavior of the WebView. The arguments are passed to the + /// browser process as part of the command. For more information about + /// using command-line switches with Chromium browser processes, navigate to + /// [Run Chromium with Flags](https://www.chromium.org/developers/how-tos/run-chromium-with-flags). + /// The value appended to a switch is appended to the browser process, for + /// example, in `--edge-webview-switches=xxx` the value is `xxx`. If you + /// specify a switch that is important to WebView functionality, it is + /// ignored, for example, `--user-data-dir`. Specific features are disabled + /// internally and blocked from being enabled. If a switch is specified + /// multiple times, only the last instance is used. + /// + /// \> [!NOTE]\n\> A merge of the different values of the same switch is not attempted, + /// except for disabled and enabled features. The features specified by + /// `--enable-features` and `--disable-features` are merged with simple + /// logic.\n\> * The features is the union of the specified features + /// and built-in features. If a feature is disabled, it is removed from the + /// enabled features list. + /// + /// If you specify command-line switches and use the + /// `additionalBrowserArguments` parameter, the `--edge-webview-switches` + /// value takes precedence and is processed last. If a switch fails to + /// parse, the switch is ignored. The default state for the operation is + /// to run the browser process with no extra flags. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT AdditionalBrowserArguments([out, retval] LPWSTR* value); + + /// Sets the `AdditionalBrowserArguments` property. + /// + /// Please note that calling this API twice will replace the previous value + /// rather than appending to it. If there are multiple switches, there + /// should be a space in between them. The one exception is if multiple + /// features are being enabled/disabled for a single switch, in which + /// case the features should be comma-seperated. + /// Ex. "--disable-features=feature1,feature2 --some-other-switch --do-something" + [propput] HRESULT AdditionalBrowserArguments([in] LPCWSTR value); + + /// The default display language for WebView. It applies to browser UI such as + /// context menu and dialogs. It also applies to the `accept-languages` HTTP + /// header that WebView sends to websites. The intended locale value is in the + /// format of BCP 47 Language Tags. More information can be found from + /// [IETF BCP47](https://www.ietf.org/rfc/bcp/bcp47.html). + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Language([out, retval] LPWSTR* value); + + /// Sets the `Language` property. + [propput] HRESULT Language([in] LPCWSTR value); + + /// Specifies the version of the WebView2 Runtime binaries required to be + /// compatible with your app. This defaults to the WebView2 Runtime version + /// that corresponds with the version of the SDK the app is using. The + /// format of this value is the same as the format of the + /// `BrowserVersionString` property and other `BrowserVersion` values. Only + /// the version part of the `BrowserVersion` value is respected. The channel + /// suffix, if it exists, is ignored. The version of the WebView2 Runtime + /// binaries actually used may be different from the specified + /// `TargetCompatibleBrowserVersion`. The binaries are only guaranteed to be + /// compatible. Verify the actual version on the `BrowserVersionString` + /// property on the `ICoreWebView2Environment`. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT TargetCompatibleBrowserVersion([out, retval] LPWSTR* value); + + /// Sets the `TargetCompatibleBrowserVersion` property. + [propput] HRESULT TargetCompatibleBrowserVersion([in] LPCWSTR value); + + /// The `AllowSingleSignOnUsingOSPrimaryAccount` property is used to enable + /// single sign on with Azure Active Directory (AAD) and personal Microsoft + /// Account (MSA) resources inside WebView. All AAD accounts, connected to + /// Windows and shared for all apps, are supported. For MSA, SSO is only enabled + /// for the account associated for Windows account login, if any. + /// Default is disabled. Universal Windows Platform apps must also declare + /// `enterpriseCloudSSO` + /// [Restricted capabilities](/windows/uwp/packaging/app-capability-declarations\#restricted-capabilities) + /// for the single sign on (SSO) to work. + [propget] HRESULT AllowSingleSignOnUsingOSPrimaryAccount([out, retval] BOOL* allow); + + /// Sets the `AllowSingleSignOnUsingOSPrimaryAccount` property. + [propput] HRESULT AllowSingleSignOnUsingOSPrimaryAccount([in] BOOL allow); +} + +/// Additional options used to create WebView2 Environment. A default implementation is +/// provided in `WebView2EnvironmentOptions.h`. +/// +/// \snippet AppWindow.cpp CreateCoreWebView2EnvironmentWithOptions + +// Note: ICoreWebView2EnvironmentOptions* interfaces derive from IUnknown to make moving +// the API from experimental to public smoothier. These interfaces are mostly internal to +// WebView's own code. Normal apps just use the objects we provided and never interact +// with the interfaces. Advanced apps might implement their own options object. In that +// case, it is also easier for them to implement the interface if it is derived from IUnknown. +[uuid(FF85C98A-1BA7-4A6B-90C8-2B752C89E9E2), object, pointer_default(unique)] +interface ICoreWebView2EnvironmentOptions2 : IUnknown { + + /// Whether other processes can create WebView2 from WebView2Environment created with the + /// same user data folder and therefore sharing the same WebView browser process instance. + /// Default is FALSE. + [propget] HRESULT ExclusiveUserDataFolderAccess([out, retval] BOOL* value); + + /// Sets the `ExclusiveUserDataFolderAccess` property. + /// The `ExclusiveUserDataFolderAccess` property specifies that the WebView environment + /// obtains exclusive access to the user data folder. + /// If the user data folder is already being used by another WebView environment with a + /// different value for `ExclusiveUserDataFolderAccess` property, the creation of a WebView2Controller + /// using the environment object will fail with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`. + /// When set as TRUE, no other WebView can be created from other processes using WebView2Environment + /// objects with the same UserDataFolder. This prevents other processes from creating WebViews + /// which share the same browser process instance, since sharing is performed among + /// WebViews that have the same UserDataFolder. When another process tries to create a + /// WebView2Controller from an WebView2Environment object created with the same user data folder, + /// it will fail with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`. + [propput] HRESULT ExclusiveUserDataFolderAccess([in] BOOL value); +} + +/// Additional options used to create WebView2 Environment to manage crash +/// reporting. +[uuid(4A5C436E-A9E3-4A2E-89C3-910D3513F5CC), object, pointer_default(unique)] +interface ICoreWebView2EnvironmentOptions3 : IUnknown { + /// When `IsCustomCrashReportingEnabled` is set to `TRUE`, Windows won't send crash data to Microsoft endpoint. + /// `IsCustomCrashReportingEnabled` is default to be `FALSE`, in this case, WebView will respect OS consent. + [propget] HRESULT IsCustomCrashReportingEnabled([out, retval] BOOL* value); + + /// Sets the `IsCustomCrashReportingEnabled` property. + [propput] HRESULT IsCustomCrashReportingEnabled([in] BOOL value); +} + +/// Additional options used to create WebView2 Environment that manages custom scheme registration. +[uuid(ac52d13f-0d38-475a-9dca-876580d6793e), object, pointer_default(unique)] +interface ICoreWebView2EnvironmentOptions4 : IUnknown { + /// Array of custom scheme registrations. The returned + /// ICoreWebView2CustomSchemeRegistration pointers must be released, and the + /// array itself must be deallocated with CoTaskMemFree. + HRESULT GetCustomSchemeRegistrations( + [out] UINT32* count, + [out] ICoreWebView2CustomSchemeRegistration*** schemeRegistrations); + /// Set the array of custom scheme registrations to be used. + /// \snippet AppWindow.cpp CoreWebView2CustomSchemeRegistration + HRESULT SetCustomSchemeRegistrations( + [in] UINT32 count, + [in] ICoreWebView2CustomSchemeRegistration** schemeRegistrations); +} + +/// Additional options used to create WebView2 Environment to manage tracking +/// prevention. +[uuid(0AE35D64-C47F-4464-814E-259C345D1501), object, pointer_default(unique)] +interface ICoreWebView2EnvironmentOptions5 : IUnknown { + /// The `EnableTrackingPrevention` property is used to enable/disable tracking prevention + /// feature in WebView2. This property enable/disable tracking prevention for all the + /// WebView2's created in the same environment. By default this feature is enabled to block + /// potentially harmful trackers and trackers from sites that aren't visited before and set to + /// `COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_BALANCED` or whatever value was last changed/persisted + /// on the profile. + /// + /// You can set this property to false to disable the tracking prevention feature if the app only + /// renders content in the WebView2 that is known to be safe. Disabling this feature when creating + /// environment also improves runtime performance by skipping related code. + /// + /// You shouldn't disable this property if WebView2 is being used as a "full browser" with arbitrary + /// navigation and should protect end user privacy. + /// + /// There is `ICoreWebView2Profile3::PreferredTrackingPreventionLevel` property to control levels of + /// tracking prevention of the WebView2's associated with a same profile. However, you can also disable + /// tracking prevention later using `ICoreWebView2Profile3::PreferredTrackingPreventionLevel` property and + /// `COREWEBVIEW2_TRACKING_PREVENTION_LEVEL_NONE` value but that doesn't improves runtime performance. + /// + /// See `ICoreWebView2Profile3::PreferredTrackingPreventionLevel` for more details. + /// + /// Tracking prevention protects users from online tracking by restricting the ability of trackers to + /// access browser-based storage as well as the network. See [Tracking prevention](/microsoft-edge/web-platform/tracking-prevention). + [propget] HRESULT EnableTrackingPrevention([out, retval] BOOL* value); + /// Sets the `EnableTrackingPrevention` property. + [propput] HRESULT EnableTrackingPrevention([in] BOOL value); +} + +/// A continuation of the ICoreWebView2Environment interface for +/// getting the crash dump folder path. +[uuid(F0913DC6-A0EC-42EF-9805-91DFF3A2966A), object, pointer_default(unique)] +interface ICoreWebView2Environment11 : ICoreWebView2Environment10 { + /// `FailureReportFolderPath` returns the path of the folder where minidump files are written. + /// Whenever a WebView2 process crashes, a crash dump file will be created in the crash dump folder. + /// The crash dump format is minidump files. Please see + /// [Minidump Files documentation](/windows/win32/debug/minidump-files) for detailed information. + /// Normally when a single child process fails, a minidump will be generated and written to disk, + /// then the `ProcessFailed` event is raised. But for unexpected crashes, a minidump file might not be generated + /// at all, despite whether `ProcessFailed` event is raised. If there are multiple + /// process failures at once, multiple minidump files could be generated. Thus `FailureReportFolderPath` + /// could contain old minidump files that are not associated with a specific `ProcessFailed` event. + /// \snippet AppWindow.cpp GetFailureReportFolder + [propget] HRESULT FailureReportFolderPath([out, retval] LPWSTR* value); +} + +/// A continuation of the ICoreWebView2Environment interface for creating shared buffer object. +[uuid(F503DB9B-739F-48DD-B151-FDFCF253F54E), object, pointer_default(unique)] +interface ICoreWebView2Environment12 : ICoreWebView2Environment11 { + /// Create a shared memory based buffer with the specified size in bytes. + /// The buffer can be shared with web contents in WebView by calling + /// `PostSharedBufferToScript` on `CoreWebView2` or `CoreWebView2Frame` object. + /// Once shared, the same content of the buffer will be accessible from both + /// the app process and script in WebView. Modification to the content will be visible + /// to all parties that have access to the buffer. + /// The shared buffer is presented to the script as ArrayBuffer. All JavaScript APIs + /// that work for ArrayBuffer including Atomics APIs can be used on it. + /// There is currently a limitation that only size less than 2GB is supported. + HRESULT CreateSharedBuffer( + [in] UINT64 size, + [out, retval] ICoreWebView2SharedBuffer** shared_buffer); +} + +/// Receives the `WebView2Environment` created using +/// `CreateCoreWebView2Environment`. +[uuid(4e8a3389-c9d8-4bd2-b6b5-124fee6cc14d), object, pointer_default(unique)] +interface ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler : IUnknown { + + /// Provides the completion status and result of the corresponding + /// asynchronous method. + + HRESULT Invoke(HRESULT errorCode, ICoreWebView2Environment* createdEnvironment); +} + +/// A Receiver is created for a particular DevTools Protocol event and allows +/// you to subscribe and unsubscribe from that event. Obtained from the +/// WebView object using `GetDevToolsProtocolEventReceiver`. +[uuid(b32ca51a-8371-45e9-9317-af021d080367), object, pointer_default(unique)] +interface ICoreWebView2DevToolsProtocolEventReceiver : IUnknown { + + /// Subscribe to a `DevToolsProtocol` event. The `Invoke` method of the + /// `handler` runs whenever the corresponding `DevToolsProtocol` event runs. + /// `Invoke` runs with an event args object containing the parameter object + /// of the DevTools Protocol event as a JSON string. + /// + /// \snippet ScriptComponent.cpp DevToolsProtocolEventReceived + + HRESULT add_DevToolsProtocolEventReceived( + [in] ICoreWebView2DevToolsProtocolEventReceivedEventHandler* handler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with + /// `add_DevToolsProtocolEventReceived`. + + HRESULT remove_DevToolsProtocolEventReceived( + [in] EventRegistrationToken token); + +} + +/// ICoreWebView2Frame provides direct access to the iframes information. +/// You can get an ICoreWebView2Frame by handling the ICoreWebView2_4::add_FrameCreated event. +[uuid(f1131a5e-9ba9-11eb-a8b3-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2Frame : IUnknown { + /// The name of the iframe from the iframe html tag declaring it. + /// You can access this property even if the iframe is destroyed. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Name([ out, retval ] LPWSTR * name); + /// Raised when the iframe changes its window.name property. + HRESULT add_NameChanged( + [in] ICoreWebView2FrameNameChangedEventHandler * eventHandler, + [out] EventRegistrationToken * token); + /// Remove an event handler previously added with add_NameChanged. + HRESULT remove_NameChanged([in] EventRegistrationToken token); + + /// Add the provided host object to script running in the iframe with the + /// specified name for the list of the specified origins. The host object + /// will be accessible for this iframe only if the iframe's origin during + /// access matches one of the origins which are passed. The provided origins + /// will be normalized before comparing to the origin of the document. + /// So the scheme name is made lower case, the host will be punycode decoded + /// as appropriate, default port values will be removed, and so on. + /// This means the origin's host may be punycode encoded or not and will match + /// regardless. If list contains malformed origin the call will fail. + /// The method can be called multiple times in a row without calling + /// RemoveHostObjectFromScript for the same object name. It will replace + /// the previous object with the new object and new list of origins. + /// List of origins will be treated as following: + /// 1. empty list - call will succeed and object will be added for the iframe + /// but it will not be exposed to any origin; + /// 2. list with origins - during access to host object from iframe the + /// origin will be checked that it belongs to this list; + /// 3. list with "*" element - host object will be available for iframe for + /// all origins. We suggest not to use this feature without understanding + /// security implications of giving access to host object from from iframes + /// with unknown origins. + /// 4. list with "file://" element - host object will be available for iframes + /// loaded via file protocol. + /// Calling this method fails if it is called after the iframe is destroyed. + /// \snippet ScenarioAddHostObject.cpp AddHostObjectToScriptWithOrigins + /// For more information about host objects navigate to + /// ICoreWebView2::AddHostObjectToScript. + HRESULT AddHostObjectToScriptWithOrigins( + [in] LPCWSTR name, + [in] VARIANT * object, + [in] UINT32 originsCount, + [ in, size_is(originsCount) ] LPCWSTR * origins); + /// Remove the host object specified by the name so that it is no longer + /// accessible from JavaScript code in the iframe. While new access + /// attempts are denied, if the object is already obtained by JavaScript code + /// in the iframe, the JavaScript code continues to have access to that + /// object. Calling this method for a name that is already removed or was + /// never added fails. If the iframe is destroyed this method will return fail + /// also. + HRESULT RemoveHostObjectFromScript([in] LPCWSTR name); + + /// The Destroyed event is raised when the iframe corresponding + /// to this CoreWebView2Frame object is removed or the document + /// containing that iframe is destroyed. + HRESULT add_Destroyed( + [in] ICoreWebView2FrameDestroyedEventHandler * eventHandler, + [out] EventRegistrationToken * token); + /// Remove an event handler previously added with add_Destroyed. + HRESULT remove_Destroyed([in] EventRegistrationToken token); + /// Check whether a frame is destroyed. Returns true during + /// the Destroyed event. + HRESULT IsDestroyed([ out, retval ] BOOL * destroyed); +} + +/// A continuation of the ICoreWebView2Frame interface with navigation events, +/// executing script and posting web messages. +[uuid(7a6a5834-d185-4dbf-b63f-4a9bc43107d4), object, pointer_default(unique)] +interface ICoreWebView2Frame2 : ICoreWebView2Frame { + /// Add an event handler for the `NavigationStarting` event. + /// A frame navigation will raise a `NavigationStarting` event and + /// a `CoreWebView2.FrameNavigationStarting` event. All of the + /// `FrameNavigationStarting` event handlers for the current frame will be + /// run before the `NavigationStarting` event handlers. All of the event handlers + /// share a common `NavigationStartingEventArgs` object. Whichever event handler is + /// last to change the `NavigationStartingEventArgs.Cancel` property will + /// decide if the frame navigation will be cancelled. Redirects raise this + /// event as well, and the navigation id is the same as the original one. + /// + /// Navigations will be blocked until all `NavigationStarting` and + /// `CoreWebView2.FrameNavigationStarting` event handlers return. + HRESULT add_NavigationStarting( + [in] ICoreWebView2FrameNavigationStartingEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NavigationStarting`. + HRESULT remove_NavigationStarting( + [in] EventRegistrationToken token); + + /// Add an event handler for the `ContentLoading` event. `ContentLoading` + /// triggers before any content is loaded, including scripts added with + /// `AddScriptToExecuteOnDocumentCreated`. `ContentLoading` does not trigger + /// if a same page navigation occurs (such as through `fragment` + /// navigations or `history.pushState` navigations). This operation + /// follows the `NavigationStarting` and precedes `NavigationCompleted` events. + HRESULT add_ContentLoading( + [in] ICoreWebView2FrameContentLoadingEventHandler * eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_ContentLoading`. + HRESULT remove_ContentLoading( + [in] EventRegistrationToken token); + + /// Add an event handler for the `NavigationCompleted` event. + /// `NavigationCompleted` runs when the CoreWebView2Frame has completely + /// loaded (concurrently when `body.onload` runs) or loading stopped with error. + HRESULT add_NavigationCompleted( + [in] ICoreWebView2FrameNavigationCompletedEventHandler * + eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_NavigationCompleted`. + HRESULT remove_NavigationCompleted( + [in] EventRegistrationToken token); + + /// Add an event handler for the DOMContentLoaded event. + /// DOMContentLoaded is raised when the iframe html document has been parsed. + /// This aligns with the document's DOMContentLoaded event in html. + HRESULT add_DOMContentLoaded( + [in] ICoreWebView2FrameDOMContentLoadedEventHandler * eventHandler, + [out] EventRegistrationToken* token); + /// Remove an event handler previously added with add_DOMContentLoaded. + HRESULT remove_DOMContentLoaded( + [in] EventRegistrationToken token); + + /// Run JavaScript code from the javascript parameter in the current frame. + /// The result of evaluating the provided JavaScript is passed to the completion handler. + /// The result value is a JSON encoded string. If the result is undefined, + /// contains a reference cycle, or otherwise is not able to be encoded into + /// JSON, then the result is considered to be null, which is encoded + /// in JSON as the string "null". + /// + /// \> [!NOTE]\n\> A function that has no explicit return value returns undefined. If the + /// script that was run throws an unhandled exception, then the result is + /// also "null". This method is applied asynchronously. If the method is + /// run before `ContentLoading`, the script will not be executed + /// and the string "null" will be returned. + /// This operation executes the script even if `ICoreWebView2Settings::IsScriptEnabled` is + /// set to `FALSE`. + /// + /// \snippet ScenarioDOMContentLoaded.cpp ExecuteScriptFrame + HRESULT ExecuteScript( + [in] LPCWSTR javaScript, + [in] ICoreWebView2ExecuteScriptCompletedHandler* handler); + + /// Posts the specified webMessage to the frame. + /// The frame receives the message by subscribing to the `message` event of + /// the `window.chrome.webview` of the frame document. + /// + /// ```cpp + /// window.chrome.webview.addEventListener('message', handler) + /// window.chrome.webview.removeEventListener('message', handler) + /// ``` + /// + /// The event args is an instances of `MessageEvent`. The + /// `ICoreWebView2Settings::IsWebMessageEnabled` setting must be `TRUE` or + /// the message will not be sent. The `data` property of the event + /// args is the `webMessage` string parameter parsed as a JSON string into a + /// JavaScript object. The `source` property of the event args is a reference + /// to the `window.chrome.webview` object. For information about sending + /// messages from the HTML document in the WebView to the host, navigate to + /// [add_WebMessageReceived](/microsoft-edge/webview2/reference/win32/icorewebview2#add_webmessagereceived). + /// The message is delivered asynchronously. If a navigation occurs before the + /// message is posted to the page, the message is discarded. + HRESULT PostWebMessageAsJson([in] LPCWSTR webMessageAsJson); + + /// Posts a message that is a simple string rather than a JSON string + /// representation of a JavaScript object. This behaves in exactly the same + /// manner as `PostWebMessageAsJson`, but the `data` property of the event + /// args of the `window.chrome.webview` message is a string with the same + /// value as `webMessageAsString`. Use this instead of + /// `PostWebMessageAsJson` if you want to communicate using simple strings + /// rather than JSON objects. + HRESULT PostWebMessageAsString([in] LPCWSTR webMessageAsString); + + /// Add an event handler for the `WebMessageReceived` event. + /// `WebMessageReceived` runs when the + /// `ICoreWebView2Settings::IsWebMessageEnabled` setting is set and the + /// frame document runs `window.chrome.webview.postMessage`. + /// The `postMessage` function is `void postMessage(object)` + /// where object is any object supported by JSON conversion. + /// + /// \snippet assets\ScenarioWebMessage.html chromeWebView + /// + /// When the frame calls `postMessage`, the object parameter is converted to a + /// JSON string and is posted asynchronously to the host process. This will + /// result in the handlers `Invoke` method being called with the JSON string + /// as its parameter. + /// + /// \snippet ScenarioWebMessage.cpp WebMessageReceivedIFrame + HRESULT add_WebMessageReceived( + [in] ICoreWebView2FrameWebMessageReceivedEventHandler * + handler, + [out] EventRegistrationToken * token); + + /// Remove an event handler previously added with `add_WebMessageReceived`. + HRESULT remove_WebMessageReceived([in] EventRegistrationToken token); +} + +/// Receives `FrameCreated` event. +[uuid(38059770-9baa-11eb-a8b3-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2FrameCreatedEventHandler : IUnknown { + /// Provides the result for the iframe created event. + HRESULT Invoke([in] ICoreWebView2 * sender, + [in] ICoreWebView2FrameCreatedEventArgs * args); +} + +/// Receives `FrameNameChanged` event. +[uuid(435c7dc8-9baa-11eb-a8b3-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2FrameNameChangedEventHandler : IUnknown { + /// Provides the result for the iframe name changed event. + /// No event args exist and the `args` parameter is set to `null`. + HRESULT Invoke([in] ICoreWebView2Frame * sender, [in] IUnknown * args); +} + +/// Receives `NavigationStarting` events for iframe. +[uuid(e79908bf-2d5d-4968-83db-263fea2c1da3), object, pointer_default(unique)] +interface ICoreWebView2FrameNavigationStartingEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Frame* sender, + [in] ICoreWebView2NavigationStartingEventArgs* args); +} + +/// Receives `ContentLoading` events for iframe. +[uuid(0d6156f2-d332-49a7-9e03-7d8f2feeee54), object, pointer_default(unique)] +interface ICoreWebView2FrameContentLoadingEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Frame* sender, + [in] ICoreWebView2ContentLoadingEventArgs* args); +} + +/// Receives `NavigationCompleted` events for iframe. +[uuid(609302ad-0e36-4f9a-a210-6a45272842a9), object, pointer_default(unique)] +interface ICoreWebView2FrameNavigationCompletedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Frame* sender, + [in] ICoreWebView2NavigationCompletedEventArgs* args); +} + +/// Receives `DOMContentLoaded` events for iframe. +[uuid(38d9520d-340f-4d1e-a775-43fce9753683), object, pointer_default(unique)] +interface ICoreWebView2FrameDOMContentLoadedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Frame* sender, + [in] ICoreWebView2DOMContentLoadedEventArgs* args); +} + +/// Receives `WebMessageReceived` events for iframe. +[uuid(e371e005-6d1d-4517-934b-a8f1629c62a5), object, pointer_default(unique)] +interface ICoreWebView2FrameWebMessageReceivedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2Frame* sender, + [in] ICoreWebView2WebMessageReceivedEventArgs* args); +} + +/// Event args for the `FrameCreated` events. +[uuid(4d6e7b5e-9baa-11eb-a8b3-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2FrameCreatedEventArgs : IUnknown { + /// The frame which was created. + [propget] HRESULT Frame([ out, retval ] ICoreWebView2Frame **frame); +} + +/// Receives `FrameDestroyed` event. +[uuid(59dd7b4c-9baa-11eb-a8b3-0242ac130003), object, pointer_default(unique)] +interface ICoreWebView2FrameDestroyedEventHandler : IUnknown { + /// Provides the result for the iframe destroyed event. + /// No event args exist and the `args` parameter is set to `null`. + HRESULT Invoke([in] ICoreWebView2Frame * sender, [in] IUnknown * args); +} + +/// Add an event handler for the `DownloadStarting` event. +[uuid(efedc989-c396-41ca-83f7-07f845a55724), object, pointer_default(unique)] +interface ICoreWebView2DownloadStartingEventHandler : IUnknown { + /// Provides the event args for the corresponding event. + HRESULT Invoke( + [in] ICoreWebView2* sender, + [in] ICoreWebView2DownloadStartingEventArgs* args); +} + +/// Event args for the `DownloadStarting` event. +[uuid(e99bbe21-43e9-4544-a732-282764eafa60), object, pointer_default(unique)] +interface ICoreWebView2DownloadStartingEventArgs : IUnknown { + /// Returns the `ICoreWebView2DownloadOperation` for the download that + /// has started. + [propget] HRESULT DownloadOperation( + [out, retval] ICoreWebView2DownloadOperation** downloadOperation); + + /// The host may set this flag to cancel the download. If canceled, the + /// download save dialog is not displayed regardless of the + /// `Handled` property. + [propget] HRESULT Cancel([out, retval] BOOL* cancel); + + /// Sets the `Cancel` property. + [propput] HRESULT Cancel([in] BOOL cancel); + + /// The path to the file. If setting the path, the host should ensure that it + /// is an absolute path, including the file name, and that the path does not + /// point to an existing file. If the path points to an existing file, the + /// file will be overwritten. If the directory does not exist, it is created. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT ResultFilePath([out, retval] LPWSTR* resultFilePath); + + /// Sets the `ResultFilePath` property. + [propput] HRESULT ResultFilePath([in] LPCWSTR resultFilePath); + + /// The host may set this flag to `TRUE` to hide the default download dialog + /// for this download. The download will progress as normal if it is not + /// canceled, there will just be no default UI shown. By default the value is + /// `FALSE` and the default download dialog is shown. + [propget] HRESULT Handled([out, retval] BOOL* handled); + + /// Sets the `Handled` property. + [propput] HRESULT Handled([in] BOOL handled); + + /// Returns an `ICoreWebView2Deferral` object. Use this operation to + /// complete the event at a later time. + HRESULT GetDeferral([out, retval] ICoreWebView2Deferral** deferral); +} + +/// Implements the interface to receive `BytesReceivedChanged` event. Use the +/// `ICoreWebView2DownloadOperation.BytesReceived` property to get the received +/// bytes count. +[uuid(828e8ab6-d94c-4264-9cef-5217170d6251), object, pointer_default(unique)] +interface ICoreWebView2BytesReceivedChangedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + HRESULT Invoke( + [in] ICoreWebView2DownloadOperation* sender, [in] IUnknown* args); +} + +/// Implements the interface to receive `EstimatedEndTimeChanged` event. Use the +/// `ICoreWebView2DownloadOperation.EstimatedEndTime` property to get the new +/// estimated end time. +[uuid(28f0d425-93fe-4e63-9f8d-2aeec6d3ba1e), object, pointer_default(unique)] +interface ICoreWebView2EstimatedEndTimeChangedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + HRESULT Invoke( + [in] ICoreWebView2DownloadOperation* sender, [in] IUnknown* args); +} + +/// Implements the interface to receive `StateChanged` event. Use the +/// `ICoreWebView2DownloadOperation.State` property to get the current state, +/// which can be in progress, interrupted, or completed. Use the +/// `ICoreWebView2DownloadOperation.InterruptReason` property to get the +/// interrupt reason if the download is interrupted. +[uuid(81336594-7ede-4ba9-bf71-acf0a95b58dd), object, pointer_default(unique)] +interface ICoreWebView2StateChangedEventHandler : IUnknown { + /// Provides the event args for the corresponding event. No event args exist + /// and the `args` parameter is set to `null`. + HRESULT Invoke( + [in] ICoreWebView2DownloadOperation* sender, [in] IUnknown* args); +} + +/// Represents a download operation. Gives access to the download's metadata +/// and supports a user canceling, pausing, or resuming the download. +[uuid(3d6b6cf2-afe1-44c7-a995-c65117714336), object, pointer_default(unique)] +interface ICoreWebView2DownloadOperation : IUnknown { + /// Add an event handler for the `BytesReceivedChanged` event. + /// + /// \snippet ScenarioCustomDownloadExperience.cpp BytesReceivedChanged + HRESULT add_BytesReceivedChanged( + [in] ICoreWebView2BytesReceivedChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_BytesReceivedChanged`. + HRESULT remove_BytesReceivedChanged( + [in] EventRegistrationToken token); + + /// Add an event handler for the `EstimatedEndTimeChanged` event. + HRESULT add_EstimatedEndTimeChanged( + [in] ICoreWebView2EstimatedEndTimeChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_EstimatedEndTimeChanged`. + HRESULT remove_EstimatedEndTimeChanged( + [in] EventRegistrationToken token); + + /// Add an event handler for the `StateChanged` event. + /// + /// \snippet ScenarioCustomDownloadExperience.cpp StateChanged + HRESULT add_StateChanged( + [in] ICoreWebView2StateChangedEventHandler* eventHandler, + [out] EventRegistrationToken* token); + + /// Remove an event handler previously added with `add_StateChanged`. + HRESULT remove_StateChanged( + [in] EventRegistrationToken token); + + /// The URI of the download. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT Uri([out, retval] LPWSTR* uri); + + /// The Content-Disposition header value from the download's HTTP response. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT ContentDisposition([out, retval] LPWSTR* contentDisposition); + + /// MIME type of the downloaded content. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT MimeType([out, retval] LPWSTR* mimeType); + + /// The expected size of the download in total number of bytes based on the + /// HTTP Content-Length header. Returns -1 if the size is unknown. + [propget] HRESULT TotalBytesToReceive([out, retval] INT64* totalBytesToReceive); + + /// The number of bytes that have been written to the download file. + [propget] HRESULT BytesReceived([out, retval] INT64* bytesReceived); + + /// The estimated end time in [ISO 8601 Date and Time Format](https://www.iso.org/iso-8601-date-and-time-format.html). + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT EstimatedEndTime([out, retval] LPWSTR* estimatedEndTime); + + /// The absolute path to the download file, including file name. Host can change + /// this from `ICoreWebView2DownloadStartingEventArgs`. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT ResultFilePath([out, retval] LPWSTR* resultFilePath); + + /// The state of the download. A download can be in progress, interrupted, or + /// completed. See `COREWEBVIEW2_DOWNLOAD_STATE` for descriptions of states. + [propget] HRESULT State([out, retval] COREWEBVIEW2_DOWNLOAD_STATE* downloadState); + + /// The reason why connection with file host was broken. + [propget] HRESULT InterruptReason( + [out, retval] COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON* interruptReason); + + /// Cancels the download. If canceled, the default download dialog shows + /// that the download was canceled. Host should set the `Cancel` property from + /// `ICoreWebView2SDownloadStartingEventArgs` if the download should be + /// canceled without displaying the default download dialog. + HRESULT Cancel(); + + /// Pauses the download. If paused, the default download dialog shows that the + /// download is paused. No effect if download is already paused. Pausing a + /// download changes the state to `COREWEBVIEW2_DOWNLOAD_STATE_INTERRUPTED` + /// with `InterruptReason` set to `COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_USER_PAUSED`. + HRESULT Pause(); + + /// Resumes a paused download. May also resume a download that was interrupted + /// for another reason, if `CanResume` returns true. Resuming a download changes + /// the state from `COREWEBVIEW2_DOWNLOAD_STATE_INTERRUPTED` to + /// `COREWEBVIEW2_DOWNLOAD_STATE_IN_PROGRESS`. + HRESULT Resume(); + + /// Returns true if an interrupted download can be resumed. Downloads with + /// the following interrupt reasons may automatically resume without you + /// calling any methods: + /// `COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_SERVER_NO_RANGE`, + /// `COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_HASH_MISMATCH`, + /// `COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON_FILE_TOO_SHORT`. + /// In these cases download progress may be restarted with `BytesReceived` + /// reset to 0. + [propget] HRESULT CanResume([out, retval] BOOL* canResume); +} + +/// A continuation of the `ICoreWebView2ProcessFailedEventArgs` interface. +[uuid(4dab9422-46fa-4c3e-a5d2-41d2071d3680), object, pointer_default(unique)] +interface ICoreWebView2ProcessFailedEventArgs2 : ICoreWebView2ProcessFailedEventArgs { + + /// The reason for the process failure. Some of the reasons are only + /// applicable to specific values of + /// `ICoreWebView2ProcessFailedEventArgs::ProcessFailedKind`, and the + /// following `ProcessFailedKind` values always return the indicated reason + /// value: + /// + /// ProcessFailedKind | Reason + /// ---|--- + /// COREWEBVIEW2_PROCESS_FAILED_KIND_BROWSER_PROCESS_EXITED | COREWEBVIEW2_PROCESS_FAILED_REASON_UNEXPECTED + /// COREWEBVIEW2_PROCESS_FAILED_KIND_RENDER_PROCESS_UNRESPONSIVE | COREWEBVIEW2_PROCESS_FAILED_REASON_UNRESPONSIVE + /// + /// For other `ProcessFailedKind` values, the reason may be any of the reason + /// values. To learn about what these values mean, see + /// `COREWEBVIEW2_PROCESS_FAILED_REASON`. + [propget] HRESULT Reason( + [out, retval] COREWEBVIEW2_PROCESS_FAILED_REASON* reason); + + /// The exit code of the failing process, for telemetry purposes. The exit + /// code is always `STILL_ACTIVE` (`259`) when `ProcessFailedKind` is + /// `COREWEBVIEW2_PROCESS_FAILED_KIND_RENDER_PROCESS_UNRESPONSIVE`. + [propget] HRESULT ExitCode( + [out, retval] int* exitCode); + + /// Description of the process assigned by the WebView2 Runtime. This is a + /// technical English term appropriate for logging or development purposes, + /// and not localized for the end user. It applies to utility processes (for + /// example, "Audio Service", "Video Capture") and plugin processes (for + /// example, "Flash"). The returned `processDescription` is empty if the + /// WebView2 Runtime did not assign a description to the process. + /// + /// The caller must free the returned string with `CoTaskMemFree`. See + /// [API Conventions](/microsoft-edge/webview2/concepts/win32-api-conventions#strings). + [propget] HRESULT ProcessDescription( + [out, retval] LPWSTR* processDescription); + + /// The collection of `FrameInfo`s for frames in the `ICoreWebView2` that were + /// being rendered by the failed process. The content in these frames is + /// replaced with an error page. + /// This is only available when `ProcessFailedKind` is + /// `COREWEBVIEW2_PROCESS_FAILED_KIND_FRAME_RENDER_PROCESS_EXITED`; + /// `frames` is `null` for all other process failure kinds, including the case + /// in which the failed process was the renderer for the main frame and + /// subframes within it, for which the failure kind is + /// `COREWEBVIEW2_PROCESS_FAILED_KIND_RENDER_PROCESS_EXITED`. + [propget] HRESULT FrameInfosForFailedProcess( + [out, retval] ICoreWebView2FrameInfoCollection** frames); +} + +/// Collection of `FrameInfo`s (name and source). Used to list the affected +/// frames' info when a frame-only render process failure occurs in the +/// `ICoreWebView2`. +[uuid(8f834154-d38e-4d90-affb-6800a7272839), object, pointer_default(unique)] +interface ICoreWebView2FrameInfoCollection : IUnknown { + + /// Gets an iterator over the collection of `FrameInfo`s. + + HRESULT GetIterator( + [out, retval] ICoreWebView2FrameInfoCollectionIterator** iterator); +} + +/// Iterator for a collection of `FrameInfo`s. For more info, see +/// `ICoreWebView2ProcessFailedEventArgs2` and +/// `ICoreWebView2FrameInfoCollection`. +[uuid(1bf89e2d-1b2b-4629-b28f-05099b41bb03), object, pointer_default(unique)] +interface ICoreWebView2FrameInfoCollectionIterator : IUnknown { + + /// `TRUE` when the iterator has not run out of `FrameInfo`s. If the + /// collection over which the iterator is iterating is empty or if the + /// iterator has gone past the end of the collection, then this is `FALSE`. + + [propget] HRESULT HasCurrent([out, retval] BOOL* hasCurrent); + + /// Get the current `ICoreWebView2FrameInfo` of the iterator. + /// Returns `HRESULT_FROM_WIN32(ERROR_INVALID_INDEX)` if HasCurrent is + /// `FALSE`. + + HRESULT GetCurrent([out, retval] ICoreWebView2FrameInfo** frameInfo); + + /// Move the iterator to the next `FrameInfo` in the collection. + + HRESULT MoveNext([out, retval] BOOL* hasNext); +} + +/// Provides a set of properties for a frame in the `ICoreWebView2`. +[uuid(da86b8a1-bdf3-4f11-9955-528cefa59727), object, pointer_default(unique)] +interface ICoreWebView2FrameInfo : IUnknown { + + /// The name attribute of the frame, as in `