c# pdf to image free library : Fillable pdf forms software SDK dll winforms windows html web forms sphinx5-part780

Sphinx Documentation, Release 1.4.1
.. index:: Python
and one pagecontains
.. index:: ! Python
then thebacklink to the latter pageis emphasized among thethreebacklinks.
Forindex directives containing only“single” entries, there is a shorthand notation:
.. index:: BNF, grammar, syntax, notation
This createsfour index entries.
Changed in version 1.1: Added see and seealso types, as well as marking main entries.
:index:
While theindex directive is a block-level markup and links to the beginning of the next paragraph,
thereis also a corresponding rolethat sets the link targetdirectlywhereit is used.
The content of the role can be a simple phrase, which is then kept in the text and used as an index
entry. It can also be a combination of text and index entry, styled like with explicit targets of cross-
references. In that case, the “target” part can be a full entry as described for the directive above. For
example:
This is a normal reST :index:`paragraph` that contains several
:index:`index entries <pair: index; entry>`.
New in version 1.1.
7.8.4 Including content based on tags
.. only:: <expression>
Include thecontent of thedirectiveonly if theexpressionis true. Theexpression should consistof tags,
like this:
.. only:: html and draft
Undefined tags arefalse, defined tags (via the-t command-lineoption orwithin conf.py, seehere)
aretrue. Boolean expressions,alsousingparentheses (likehtml and (latex or draft))aresup-
ported.
The format and the name of the current builder (html, latex or text) are always set as a tag
94
.
To make the distinction between format and name explicit, they are also added with the prefix
format_ and builder_, e.g. the epub builder defines the tags html, epub, format_html and
builder_epub.
These standard tags are set after the configuration fileis read, sotheyare notavailablethere.
All tagsmust follow the standard Pythonidentifiersyntax as setoutin theIdentifiersandkeywords
93
documentation. Thatis,atagexpression mayonlyconsistoftagsthatconformtothesyntaxof Python
variables. In ASCII, this consists of the uppercase and lowercase letters A through Z, the underscore
_and, except for the firstcharacter, the digits 0 through 9.
94
For mostbuildersnameandformatarethe same. Atthe momentonlybuildersderivedfromthe htmlbuilderdistinguishbetween
thebuilder formatandthe builder name.
Notethat the currentbuilder tag isnotavailable in conf.py,itisonlyavailable after the builder isinitialized.
93
https://docs.python.org/2/reference/lexical_analysis.html#identifiers
7.8. Miscellaneous markup
45
Fillable pdf forms - C# PDF Form Data fill-in Library: auto fill-in PDF form data in C#.net, ASP.NET, MVC, WinForms, WPF
Online C# Tutorial to Automatically Fill in Field Data to PDF
create a fillable pdf form from a word document; pdf form filler
Fillable pdf forms - VB.NET PDF Form Data fill-in library: auto fill-in PDF form data in vb.net, ASP.NET, MVC, WinForms, WPF
VB.NET PDF Form Data fill-in library: auto fill-in PDF form data in vb.net, ASP.NET, MVC, WinForms, WPF
convert word document to pdf fillable form; convert word form to fillable pdf form
Sphinx Documentation, Release 1.4.1
New in version 0.6.
Changed in version 1.2: Added the name of thebuilder and the prefixes.
7.8.5 Tables
UsestandardreStructuredTexttables. They workfinein HTML output, howeverthereare somegotchaswhen
using tables in LaTeX: the column width is hard to determine correctly automatically. For this reason, the
following directive exists:
.. tabularcolumns:: column spec
This directive gives a “column spec” for the next table occurring in the source file. The spec is the
second argument to the LaTeX tabulary package’s environment (which Sphinx uses to translate
tables). Itcan have values like
|l|l|l|
which means three left-adjusted, nonbreaking columns. For columns with longer text that should
automatically bebroken, use eitherthe standard p{width} construct, ortabulary’s automatic speci-
fiers:
L
flush left column with automatic width
R
flush rightcolumn with automatic width
C
centered column with automatic width
J
justified column with automatic width
The automatic width is determined byrenderingthe content in the table, and scaling them according
totheir share of thetotal width.
By default,Sphinx uses a table layoutwith L forevery column.
New in version 0.3.
Warning: Tables that contain list-like elements such as object descriptions, blockquotes or any kind
of lists cannot be set out of the box with tabulary. They are therefore set with the standard LaTeX
tabular environment if you don’t give a tabularcolumns directive. If you do, the table will be set
with tabulary, butyou mustusethep{width} construct for thecolumns thatcontainthese elements.
Literal blocks do not work with tabulary at all, so tables containing a literal block are always set
with tabular. Also, the verbatim environment used for literal blocks only works in p{width}
columns, which means that by default, Sphinx generates such column specs for such tables. Use the
tabularcolumnsdirectivetogetfinercontroloversuchtables.
More markup is added bySphinxDomains.
46
Chapter 7. Sphinx Markup Constructs
C# Create PDF Library SDK to convert PDF from other file formats
Batch create adobe PDF from multiple forms. Create and save editable PDF with a blank page, bookmarks, links, signatures Create fillable PDF document with fields.
c# fill out pdf form; create fillable forms in pdf
C# PDF Field Edit Library: insert, delete, update pdf form field
provide best ways to create PDF forms and delete PDF forms in C#.NET framework project. A professional PDF form creator supports to create fillable PDF form in
convert word to pdf fillable form online; create fill in pdf forms
CHAPTER
8
Sphinx Domains
New in version 1.0.
8.1 What is a Domain?
Originally, Sphinx was conceived for a single project, the documentation of the Python language. Shortly
afterwards, it was madeavailable for everyone as a documentation tool, but the documentation of Python
modules remained deeply built in – the most fundamental directives, like function, were designed for
Pythonobjects. Since Sphinx has become somewhat popular,interest developed in usingitformany differ-
ent purposes: C/C++ projects, JavaScript, or even reStructuredTextmarkup (like in this documentation).
Whilethiswas always possible,itisnow mucheasiertoeasilysupport documentation ofprojects usingdif-
ferent programming languages or even ones notsupported by the main Sphinx distribution, by providing
adomain for every such purpose.
Adomain is a collection of markup (reStructuredTextdirectives androles) to describe and link toobjects
belongingtogether, e.g. elements ofa programming language. Directive and role names in a domain have
names like domain:name, e.g. py:function. Domains can also provide custom indices (like the Python
ModuleIndex).
Having domains means that there are no naming problems when one set of documentation wants to refer
to e.g. C++ and Pythonclasses. Italso means thatextensions that supportthe documentation of whole new
languages aremuch easiertowrite.
This section describes what the domains that come with Sphinx provide. The domain API is documented
as well,in the sectionDomainAPI.
8.2 Basic Markup
Most domains providea number ofobjectdescription directives,used todescribespecific objects provided by
modules. Each directive requires one or more signatures toprovide basic information about what is being
described, and thecontentshould bethe description. Thebasic version makes entries in the general index;
ifno index entry isdesired,you can give thedirective optionflag :noindex:. An example using a Python
domain directive:
.. py:function:: spam(eggs)
ham(eggs)
Spam or ham the foo.
47
VB.NET Create PDF from OpenOffice to convert odt, odp files to PDF
Export PDF document from OpenOffice Presentation. Turn ODT, ODS, ODP forms into fillable PDF formats. Quick integrate online source code to VB.NET class project
convert fillable pdf to html form; create a pdf with fields to fill in
C# Create PDF from OpenOffice to convert odt, odp files to PDF in
An advanced .NET control to change ODT, ODS, ODP forms to fillable PDF formats in Visual C# .NET. Online source code for C#.NET class.
convert pdf to pdf form fillable; convert pdf file to fillable form online
Sphinx Documentation, Release 1.4.1
This describes the two Python functions spam and ham. (Note that when signatures become too long, you
can break them if you add a backslash to lines that arecontinued in the nextline. Example:
.. py:function:: filterwarnings(action, message='', category=Warning, \
module='', lineno=0, append=False)
:noindex:
(This examplealso shows how to usethe :noindex: flag.)
The domains also provide roles that link back to these object descriptions. For example, to link to one of
the functions described in the example above, you could say
The function :py:func:`spam` does a similar thing.
As you can see, both directiveand role names contain the domain nameand the directive name.
Default Domain
To avoid having to writing the domain name all the time when you e.g. only describe Python objects, a
default domain can beselected with eitherthe config valueprimary_domain or this directive:
.. default-domain:: name
Select a new default domain. While theprimary_domain selects a global default, this only has an
effect within the samefile.
If no other default is selected, the Python domain (named py) is the default one, mostly for compatibility
with documentation written forolder versions of Sphinx.
Directives and roles that belongtothe default domain can be mentioned without giving the domain name,
i.e.
.. function:: pyfunc()
Describes a Python function.
Reference to :func:`pyfunc`.
8.2.1 Cross-referencing syntax
Forcross-referenceroles provided by domains, the same facilities exist as for general cross-references. See
Cross-referencing syntax.
In short:
• You maysupplyan explicit titleand referencetarget: :role:‘title <target>‘ will refertotarget,
butthe link textwill betitle.
• Ifyou prefix the content with !, no reference/hyperlinkwill becreated.
• Ifyou prefix thecontentwith ~,thelinktextwill onlybethelastcomponentofthetarget. Forexample,
:py:meth:‘~Queue.Queue.get‘ will refer to Queue.Queue.get but only display get as the
linktext.
8.3 The Python Domain
The Python domain (namepy)providesthefollowingdirectives for moduledeclarations:
48
Chapter 8. Sphinx Domains
VB.NET Create PDF Library SDK to convert PDF from other file
create adobe PDF document from multiple forms in VB Create and save editable PDF with a blank page Create fillable PDF document with fields in Visual Basic .NET
allow users to attach to pdf form; create pdf fill in form
C# PDF Text Box Edit Library: add, delete, update PDF text box in
Able to create a fillable and editable text box to PDF Since RasterEdge XDoc.PDF SDK is based on .NET framework ASP.NET web service and Windows Forms for any
form pdf fillable; add fillable fields to pdf
Sphinx Documentation, Release 1.4.1
.. py:module:: name
This directive marks the beginning of the description of a module (or package submodule, in which
case the name should be fully qualified, including thepackage name). It does not create content (like
e.g.py:class does).
This directive will alsocause an entry in the global module index.
The platform option, if present, is a comma-separated list of the platforms on which the module
is available (if it is available on all platforms, the option should be omitted). The keys are short
identifiers; examples that are in use include “IRIX”, “Mac”, “Windows”, and “Unix”. It is important
tousea key which has already been used when applicable.
Thesynopsis option should consistof onesentencedescribingthemodule’spurpose–itiscurrently
only used in the Global Module Index.
The deprecated option can be given (with no value) to mark a module as deprecated; it will be
designated as such in various locations then.
.. py:currentmodule:: name
This directive tells Sphinx that the classes, functions etc. documented from here are in the given
module (likepy:module), but it will not create index entries, an entry in the Global Module Index,
or a link target forpy:mod. This is helpful in situations where documentation for things in a module
is spread over multiple files or sections – one location has thepy:module directive, the others only
py:currentmodule.
The following directives areprovided for module and class contents:
.. py:function:: name(parameters)
Describes a module-level function. The signature should include the parameters as given in the
Python function definition,seePythonSignatures. Forexample:
.. py:function:: Timer.repeat(repeat=3, number=1000000)
Formethods you should usepy:method.
The description normally includesinformationaboutthe parameters required and how they are used
(especially whether mutable objects passed as parameters are modified), side effects, and possible
exceptions.
This information can (in anypy directive) optionally be given in a structured form, seeInfofieldlists.
.. py:data:: name
Describes global data in a module, including both variables and values used as “defined constants.”
Class and object attributes are not documented using this environment.
.. py:exception:: name
Describes an exception class. The signature can, but need not include parentheses with constructor
arguments.
.. py:class:: name
.. py:class:: name(parameters)
Describes a class. The signature can optionally include parentheses with parameters which will be
shown as theconstructorarguments. See alsoPythonSignatures.
Methods and attributes belonging to the class should be placed in this directive’s body. If they are
placed outside, the supplied name should contain the class name so that cross-references still work.
Example:
.. py:class:: Foo
.. py:method:: quux()
8.3. The Python Domain
49
Sphinx Documentation, Release 1.4.1
-- or --
.. py:class:: Bar
.. py:method:: Bar.quux()
The firstway is thepreferred one.
.. py:attribute:: name
Describes an object data attribute. The description should include information about the type of the
data tobeexpected and whether itmaybechanged directly.
.. py:method:: name(parameters)
Describes an object method. Theparameters should not include theself parameter. The description
should include similar information to that described for function. See alsoPythonSignaturesand
Info field lists.
.. py:staticmethod:: name(parameters)
Likepy:method,butindicates thatthe method is a static method.
New in version 0.4.
.. py:classmethod:: name(parameters)
Likepy:method,butindicates thatthe method is a class method.
New in version 0.6.
.. py:decorator:: name
.. py:decorator:: name(parameters)
Describes adecorator function. Thesignatureshould representthe usage as adecorator. Forexample,
given the functions
def removename(func):
func.__name__ ''
return func
def setnewname(name):
def decorator(func):
func.__name__ = name
return func
return decorator
the descriptions should look like this:
.. py:decorator:: removename
Remove name of the decorated function.
.. py:decorator:: setnewname(name)
Set name of the decorated function to
*
name
*
.
(as opposed to ..
py:decorator:: removename(func).)
There is no py:deco role to link to a decorator that is marked up with this directive; rather, use the
py:funcrole.
.. py:decoratormethod:: name
50
Chapter 8. Sphinx Domains
Sphinx Documentation, Release 1.4.1
.. py:decoratormethod:: name(signature)
Sameaspy:decorator, but for decorators that are methods.
Refer to a decoratormethod using thepy:meth role.
8.3.1 Python Signatures
Signatures of functions, methods and class constructors can be given like they would bewritten in Python.
Default values for optional arguments can be given (but if they contain commas, they will confuse the
signatureparser). Python 3-styleargumentannotations can alsobegiven as wellasreturn type annotations:
.. py:function:: compile(source : string, filename, symbol='file') -> ast object
Forfunctions with optional parameters thatdon’t have default values (typically functions implemented in
Cextension modules without keyword argument support), you can use brackets to specify the optional
parts:
compile(source
[
,filename
[
,symbol
]]
)
It is customarytoput the openingbracket before the comma.
8.3.2 Info field lists
New in version 0.4.
Inside Python object description directives, reST field lists with these fields are recognized and formatted
nicely:
• param, parameter, arg, argument, key, keyword: Description of a parameter.
• type: Type of aparameter. Creates a link ifpossible.
• raises, raise,except, exception: That (and when) a specific exception is raised.
• var, ivar,cvar: Description ofa variable.
• vartype: Typeofa variable. Creates a link if possible.
• returns, return: Description of thereturn value.
• rtype: Return type. Creates a link if possible.
The field names mustconsist of one of these keywords and an argument(except for returns and rtype,
which donot need an argument). This is best explained byan example:
.. py:function:: send_message(sender, recipient, message_body, [priority=1])
Send a message to a recipient
:param str sender: The person sending g the e message
:param str recipient: The recipient t of f the message
:param str message_body: The body y of the e message
:param priority: The priority y of f the message, can be e a a number 1-5
:type priority: integer or r None
:return: the message e id
:rtype: int
:raises ValueError: if the e message_body exceeds s 160 characters
:raises TypeError: if the message_body is s not t a a basestring
8.3. The Python Domain
51
Sphinx Documentation, Release 1.4.1
This will render like this:
send_message(sender,recipient,message_body
[
,priority=1
]
)
Send a message to a recipient
Parameters
• sender (str) – Theperson sending the message
• recipient (str) – Therecipient of the message
• message_body (str) – The body of themessage
• priority (integer or None) – The priority of the message, can be a
number 1-5
Returns the message id
Return type int
Raises
• ValueError – if themessage_bodyexceeds 160 characters
• TypeError – if the message_bodyis not a basestring
It is also possible to combineparametertype and description,if the type is a single word, like this:
:param int priority: The priority of the message, , can n be a number 1-5
8.3.3 Cross-referencing Python objects
The following roles refer to objects in modules and are possibly hyperlinked if a matching identifier is
found:
:py:mod:
Reference a module; a dotted namemay be used. This should alsobeused forpackage names.
:py:func:
Reference a Python function; dotted names may be used. The role text needs not include
trailing parentheses to enhance readability; they will be added automatically by Sphinx if the
add_function_parenthesesconfigvalueisTrue(thedefault).
:py:data:
Reference a module-level variable.
:py:const:
Reference a “defined” constant. This may be a Python variable that is notintended tobechanged.
:py:class:
Reference a class;a dotted name may be used.
:py:meth:
Reference a method of an object. The role text can include the type name and the method name; if it
occurswithin the description of a type,the type namecan be omitted. A dotted name may be used.
:py:attr:
Reference a data attribute of an object.
:py:exc:
Reference an exception. Adotted name may be used.
52
Chapter 8. Sphinx Domains
Sphinx Documentation, Release 1.4.1
:py:obj:
Reference an objectof unspecified type. Useful e.g. as thedefault_role.
New in version 0.4.
The name enclosed in this markup can include a module name and/or a class name. For example,
:py:func:‘filter‘ could refertoa function named filter in the currentmodule,or thebuilt-in func-
tion ofthatname. In contrast, :py:func:‘foo.filter‘ clearlyrefers tothe filter function in thefoo
module.
Normally, names in these roles are searched first without any further qualification, then with the current
module name prepended, then with the current module and class name (if any) prepended. If you pre-
fix the name with a dot, this order is reversed. For example, in the documentation of Python’s codecs
module, :py:func:‘open‘ always refers to the built-in function, while :py:func:‘.open‘ refers to
codecs.open().
Asimilarheuristic isused todeterminewhether thenameis an attributeofthecurrentlydocumented class.
Also, if the name is prefixed with a dot, and no exact match is found, the target is taken as a suffix and
all object names with that suffix are searched. For example, :py:meth:‘.TarFile.close‘ references
the tarfile.TarFile.close() function,even if thecurrentmodule is not tarfile. Sincethis can get
ambiguous, if thereis more than one possiblematch,you will get a warning from Sphinx.
Note that you can combine the ~ and . prefixes: :py:meth:‘~.TarFile.close‘ will reference the
tarfile.TarFile.close() method, but the visiblelinkcaption will only be close().
8.4 The C Domain
The Cdomain (name c) is suited for documentation of C API.
.. c:function:: type name(signature)
Describes a C function. The signatureshould begiven as in C, e.g.:
.. c:function:: PyObject
*
PyType_GenericAlloc(PyTypeObject
*
type, Py_ssize_t
˓→
nitems)
This is also used to describe function-like preprocessor macros. The names of the arguments should
begiven so they may be used in the description.
Notethat you don’t haveto backslash-escapeasterisks in thesignature, asit isnot parsed by the reST
inliner.
.. c:member:: type name
Describes a C struct member. Example signature:
.. c:member:: PyObject
*
PyTypeObject.tp_bases
The text of the description should include the range of values allowed, how the value should be
interpreted, and whether the value can be changed. References to structure members in text should
use themember role.
.. c:macro:: name
Describes a “simple” C macro. Simple macros are macros which are used for code expansion,
but which do not take arguments so cannot be described as functions. This is a simple C-
language #define. Examples of its use in the Python documentation includePyObject_HEAD and
Py_BEGIN_ALLOW_THREADS.
8.4. The C Domain
53
Sphinx Documentation, Release 1.4.1
.. c:type:: name
Describes a C type (whether defined by a typedef or struct). The signature should just be the type
name.
.. c:var:: type name
Describes a global C variable. The signatureshould includethe type, such as:
.. c:var:: PyObject
*
PyClass_Type
8.4.1 Cross-referencing C constructs
The following roles create cross-references to C-language constructs if they are defined in the documenta-
tion:
:c:data:
Reference a C-language variable.
:c:func:
Reference a C-language function. Should include trailingparentheses.
:c:macro:
Reference a “simple” C macro, as defined above.
:c:type:
Reference a C-language type.
8.5 The C++ Domain
The C++ domain (namecpp) supports documentingC++ projects.
The following directives are available. All declarations can start with a visibility statement (public,
private or protected).
.. cpp:class:: class specifier
Describe aclass/struct,possiblywith specification of inheritance, e.g.,:
.. cpp:class:: MyClass : public MyBase, MyOtherBase
The class can bedirectly declared inside a nested scope, e.g.,:
.. cpp:class:: OuterScope::MyClass : public MyBase, MyOtherBase
Atemplate class can bedeclared:
.. cpp:class:: template<typename T, std::size_t N> std::array
or with a linebreak:
.. cpp:class:: template<typename T, std::size_t N> \
std::array
Full and partial templatespecialisations can bedeclared:
.. cpp::class:: template<> \
std::array<bool, 256>
54
Chapter 8. Sphinx Domains
Documents you may be interested
Documents you may be interested