📄 pdftechlib.xml
字号:
<summary>
If property is set to true, the user may not change the value of the field.
</summary>
</member>
<member name="P:PDFTech.PDFControl.Required">
<summary>
If set, the control must have a value at the time it is exported by a submit-form action
</summary>
</member>
<member name="P:PDFTech.PDFControl.Name">
<summary>
Name of field used for export when the PDF document submitted.
</summary>
</member>
<member name="P:PDFTech.PDFControl.Color">
<summary>
Specifies the background color of the control.
</summary>
</member>
<member name="P:PDFTech.PDFControl.Font">
<summary>
Controls the attributes of text written on or in the control.
</summary>
</member>
<member name="P:PDFTech.PDFControl.Hint">
<summary>
Contains the text string that can appear when the user moves the mouse over the control.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnMouseUp">
<summary>
An action to be performed when the mouse button is released inside the PDF control's active area.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnMouseDown">
<summary>
An action to be performed when the mouse button is pressed inside the PDF control's active area.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnMouseEnter">
<summary>
An action to be performed when the cursor enters the PDF control's active area.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnMouseExit">
<summary>
An action to be performed when the cursor exits the PDF control's active area.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnSetFocus">
<summary>
An action to be performed when the PDF control receives the input focus.
</summary>
</member>
<member name="P:PDFTech.PDFControl.OnLostFocus">
<summary>
An action to be performed when the PDF control is "blurred" (loses the input focus).
</summary>
</member>
<member name="M:PDFTech.PDFInputControl.SetAction_OnKeyPress(System.String)">
<summary>
A JavaScript action to be performed when the user types a keystroke into a text or combo box or modifies the selection in a scrollable list.
</summary>
<remarks>
This allows the keystroke to be checked for validity and rejected or modified.
</remarks>
</member>
<member name="M:PDFTech.PDFInputControl.SetAction_OnBeforeFormatting(System.String)">
<summary>
A JavaScript action to be performed before the field is formatted to display its current value. This allows the field's value to be modified before formatting.
</summary>
</member>
<member name="M:PDFTech.PDFInputControl.SetAction_OnChange(System.String)">
<summary>
A JavaScript action to be performed when the field's value is changed. This allows the new value to be checked for validity.
</summary>
</member>
<member name="M:PDFTech.PDFInputControl.SetAction_OnOtherControlChanged(System.String)">
<summary>
A JavaScript action to be performed when the value of another field changes, in order to recalculate the value of this field.
</summary>
</member>
<member name="P:PDFTech.PDFEdit.Text">
<summary>
Text displayed in PDFEdit control when file is created.
</summary>
<remarks>
This property specifies the content that is displayed in the text box when the text box does not have the focus.
</remarks>
</member>
<member name="P:PDFTech.PDFEdit.Multiline">
<summary>
If property is set to true, the PDFEdit may contain multiple lines of text; if false, the field's text is restricted to a single line.
</summary>
</member>
<member name="P:PDFTech.PDFEdit.IsPassword">
<summary>
If set, the field is intended for entering a secure password that should not be echoed visibly to the screen.
</summary>
<remarks>Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.</remarks>
</member>
<member name="P:PDFTech.PDFEdit.MaxLength">
<summary>
The maximum length of the field's text, in characters.
</summary>
</member>
<member name="P:PDFTech.PDFEdit.Justification">
<summary>
Justification of input text.
</summary>
</member>
<member name="T:PDFTech.Canvas">
<summary>
Canvas provides a drawing space for objects that must render their own images on CurrentPage.
</summary>
<remarks>
The class supports drawing and filling a variety of shapes and lines, writing text and rendering graphic images.
</remarks>
</member>
<member name="M:PDFTech.Canvas.Add1DBarcode(PDFTech.Barcodes.Barcode1D.PDFBarcode1D,System.Double,System.Double)">
<summary>
This function adds a linear barcode to the canvas.
</summary>
<param name="Barcode"></param>
<param name="X">Barcode X position</param>
<param name="Y">Barcode Y position</param>
<remarks>Using the Add1DBarcode method, you may add many different types of linear barcodes to the canvas.</remarks>
<example>
The example below shows how a linear barcode can be added to a PDF document.
<code>
PDFDocument doc = new PDFDocument("barcode.pdf");
doc.AutoLaunch = true;
PDFTech.Barcodes.Barcode1D.Ean13 ean13 = new PDFTech.Barcodes.Barcode1D.Ean13("123456789012", UnitOfMeasure.Pixel);
if (ean13.IsCodeValid())
{
doc.CurrentPage.Body.Add1DBarcode(ean13, 130, 100);
}
if (!doc.Save())
Console.WriteLine(doc.Error);
</code>
</example>
</member>
<member name="M:PDFTech.Canvas.Add2DBarcode(PDFTech.Barcodes.Barcode2D.PDFBarcode2D,System.Double,System.Double)">
<summary>
This function adds a two dimensional barcode to the canvas.
</summary>
<param name="barcode"></param>
<param name="X">Barcode X position</param>
<param name="Y">Barcode Y position</param>
<remarks>Using the Add2DBarcode method, you may add many different types of two dimensionalbarcodes to the canvas.</remarks>
<example>
The example below shows how a two dimensional barcode can be added to a PDF document.
<code>
PDFDocument doc = new PDFDocument("barcode.pdf");
doc.AutoLaunch = true;
PDFTech.Barcodes.Barcode2D.DataMatrix dataMatrix = new PDFTech.Barcodes.Barcode2D.DataMatrix("123456789 PDFTech", UnitOfMeasure.Pixel);
if (dataMatrix.IsCodeValid())
{
doc.CurrentPage.Body.Add2DBarcode(dataMatrix, 130, 100);
}
if (!doc.Save())
Console.WriteLine(doc.Error);
</code>
</example>
</member>
<member name="M:PDFTech.Canvas.AddMetaFile(System.Drawing.Imaging.Metafile)">
<summary>
Procedure paints context of the metafile on the page.
</summary>
<param name="MF">Metafile file to be rendered</param>
</member>
<member name="M:PDFTech.Canvas.AddMetaFile(System.Drawing.Imaging.Metafile,System.Double,System.Double,System.Double,System.Double)">
<summary>
Procedure paints context of the metafile on the page.
</summary>
<param name="MF"> Metafile file to be rendered </param>
<param name="x">Top level corner left value</param>
<param name="y">Top level corner top value</param>
<param name="XScale">Scale of width when painting on the page.</param>
<param name="YScale">Scale of height when painting on the page.</param>
</member>
<member name="M:PDFTech.Canvas.AddText(System.String)">
<summary>
This function allows text to be writtento the canvas.
</summary>
<remarks>
The AddText function allows the writing of text regardless of text size or length. If the amount of text to be written exceeds the page capacity, overflowing text is automatically rendered on the next page. The returned value indicates the current page. The current position can be traced from the <see cref="P:PDFTech.Canvas.Cursor">Cursor</see> value.
</remarks>
<param name="Text">Text to be written</param>
</member>
<member name="M:PDFTech.Canvas.AddTaggedText(System.String)">
<summary>
This function allows the writing of tagged text to the canvas.
</summary>
<remarks>
The AddTaggedText function allows the writing of text regardless of text size or length. If the amount of text to be written exceeds the page capacity, overflowing text is automatically rendered on the next page. The returned value indicates the current page. The current position can be traced from the <see cref="P:PDFTech.Canvas.Cursor">Cursor</see> value.
<para> Valid tags are the following:
<list type="bullet">
<item>font</item>
<item>b</item>
<item>i</item>
<item>u</item>
<item>st</item>
<item>br</item>
<item>sub</item>
<item>sup</item>
<item>a</item>
<item>p</item>
<item>hr</item>
</list>
</para>
</remarks>
<param name="taggedText">Text to be written</param>
</member>
<member name="M:PDFTech.Canvas.SetActiveFont(System.String,PDFTech.PDFFontStyles,System.Double)">
<summary>
This procedure sets the active font for text operations.
</summary>
<param name="FontName">Font name</param>
<param name="fontStyle">Font style</param>
<param name="FontSize">Font size</param>
<remarks>
This function sets the font value of the canvas. PDFTechLib retrieves the required information from the underlying system and embeds this information into the PDF.
</remarks>
</member>
<member name="M:PDFTech.Canvas.SetActiveFont(System.String,PDFTech.PDFFontStyles,System.Double,PDFTech.Charset)">
<summary>
This procedure sets the active font for text operations.
</summary>
<param name="FontName">Font name</param>
<param name="fontStyle">Font style</param>
<param name="FontSize">Font size</param>
<param name="FontCharset">Font charset</param>
<remarks>
This function sets the font value of the canvas. PDFTechLib retrieves the required information from the underlying system and embeds this information into the PDF.
</remarks>
</member>
<member name="M:PDFTech.Canvas.SetActiveFont(System.String,PDFTech.PDFFontStyles,System.Double,PDFTech.Charset,System.Drawing.Color)">
<summary>
This procedure sets the active font for text operations.
</summary>
<param name="FontName">Font name</param>
<param name="fontStyle">Font style</param>
<param name="FontSize">Font size</param>
<param name="FontCharset">Font charset</param>
<param name="fontColor">Font color</param>
<remarks>
This function sets the font value of the canvas. PDFTechLib retrieves the required information from the underlying system and embeds this information into the PDF.
</remarks>
</member>
<member name="M:PDFTech.Canvas.SetCjkFont(PDFTech.CJKFonts,PDFTech.PDFFontStyles,System.Double)">
<summary>
This function embeds the Chinese, japanese and korean fonts
</summary>
<param name="CJKType">CJK type</param>
<param name="fontStyle">Font style</param>
<param name="FontSize">Font size</param>
</member>
<member name="M:PDFTech.Canvas.SetCharacterSpacing(System.Double)">
<summary>
This procedure sets the additional space (in points) that should be inserted between
characters.
</summary>
<param name="Spacing">Spacing value</param>
</member>
<member name="M:PDFTech.Canvas.SetHorizontalScaling(System.Double)">
<summary>
This procedure sets the horizontal scaling factor in a percentage.
</summary>
<remarks>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -