c# pdf to image pdfsharp : Convert pdf forms to fillable control Library system azure asp.net web page console sphinx17-part767

Sphinx Documentation, Release 1.4.1
exception sphinx.application.ExtensionError
All thesemethods raise this exception ifsomething wentwrongwith theextension API.
Emitting events
Sphinx.emit(event, *arguments)
Emit event and pass arguments tothe callback functions. Return the return values of all callbacks as a
list. Donot emitcoreSphinx events in extensions!
Sphinx.emit_firstresult(event, *arguments)
Emit event and pass arguments to the callback functions. Return the result of the first callback that
doesn’t return None.
New in version 0.5.
Producing messages / logging
The application object alsoprovides support foremittingleveled messages.
Note: There is no “error” call: in Sphinx, errors are defined as things that stop the build; just raise an
exception (sphinx.errors.SphinxError ora custom subclass) to dothat.
Sphinx.warn(message, location=None, prefix=’WARNING: ‘,type=None, subtype=None)
Emit a warning.
If location is given, it should eitherbe a tuple of (docname, lineno) or a string describing the location
of the warning as well as possible.
prefix usually should notbechanged.
type and subtype areused to suppress warnings withsuppress_warnings.
Note: For warnings emitted during parsing, you should useBuildEnvironment.warn() since
that will collectall warnings duringparsing forlateroutput.
Sphinx.info(message=’‘,nonl=False)
Emit an informational message.
Ifnonl is true,don’temit a newlineatthe end (which implies thatmore infooutputwill follow soon.)
Sphinx.verbose(message, *args,**kwargs)
Emit a verbose informational message.
The message will onlybeemitted forverbositylevels >= 1 (i.e. atleastone -v option was given).
Themessagecancontain%-styleinterpolationplaceholders,whichisformatted with eitherthe
*
args
or
**
kwargs when output.
Sphinx.debug(message, *args,**kwargs)
Emit a debug-level informational message.
The message will onlybeemitted forverbositylevels >= 2 (i.e. atleasttwo-v options weregiven).
Themessagecancontain%-styleinterpolationplaceholders,whichisformatted with eitherthe
*
args
or
**
kwargs when output.
15.2. APIs used for writing extensions
165
Convert pdf forms to fillable - 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
pdf form filler; add attachment to pdf form
Convert pdf forms to fillable - 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 form to fillable pdf; pdf form fill
Sphinx Documentation, Release 1.4.1
Sphinx.debug2(message, *args,**kwargs)
Emit a lowlevel debug-level informational message.
The message will onlybeemitted forverbositylevel 3 (i.e. three -v options were given).
Themessagecancontain%-styleinterpolationplaceholders,whichisformatted with eitherthe
*
args
or
**
kwargs when output.
Sphinx core events
These events are known to the core. The arguments shown are given to the registered event handlers.
Useconnect() in an extension’s setup function (note that conf.py can also have a setup function) to
connect handlers tothe events. Example:
def source_read_handler(app, docname, , source):
print('do something here...')
def setup(app):
app.connect('source-read', source_read_handler)
builder-inited(app)
Emitted when thebuilderobject has been created. It is available as app.builder.
env-get-outdated(app,env,added, changed,removed)
Emitted when the environment determines which source files have changed and should be re-read.
added, changedand removed are sets ofdocnames that theenvironment has determined. You canreturn
alistof docnames to re-read in addition tothese.
New in version 1.1.
env-purge-doc(app,env,docname)
Emitted when all traces of a source file should be cleaned from the environment,that is, if the source
fileisremoved orbeforeitisfreshlyread. Thisisforextensionsthatkeeptheirowncachesinattributes
of the environment.
Forexample,thereis acacheofall modules ontheenvironment. Whena sourcefile hasbeen changed,
the cache’s entries for the file are cleared, since the module declarations could have been removed
from the file.
New in version 0.5.
env-before-read-docs(app,env, docnames)
Emitted after the environment has determined the list of all added and changed files and just before
it reads them. It allows extension authors to reorder the list of docnames (inplace) before processing,
or add more docnames that Sphinx did not consider changed (but never add any docnames that are
not in env.found_docs).
You can also remove document names; do this with caution since it will make Sphinx treat changed
files as unchanged.
New in version 1.3.
source-read(app,docname, source)
Emitted when a source file has been read. The source argument is a list whose single element is the
contents of the source file. You can process the contents and replace this item to implement source-
level transformations.
For example, if you want to use $ signs to delimit inline math, like in LaTeX, you can use a regular
expression toreplace $...$ by :math:‘...‘.
166
Chapter 15. Developing extensions for Sphinx
C# Create PDF from OpenOffice to convert odt, odp files to PDF in
Convert OpenOffice Text Document to PDF with embedded fonts. Create PDF document from OpenOffice Presentation in both to change ODT, ODS, ODP forms to fillable
pdf create fillable form; add signature field to pdf
VB.NET Create PDF from OpenOffice to convert odt, odp files to PDF
Convert OpenOffice Spreadsheet data to PDF. Export PDF document from OpenOffice Presentation. Turn ODT, ODS, ODP forms into fillable PDF formats.
change font size pdf fillable form; convert word to pdf fillable form online
Sphinx Documentation, Release 1.4.1
New in version 0.5.
doctree-read(app,doctree)
Emitted when a doctree has been parsed and read by the environment, and is about to be pickled.
The doctree can bemodified in-place.
missing-reference(app,env, node, contnode)
Emitted when a cross-reference to aPython module orobject cannot be resolved. Ifthe eventhandler
can resolve thereference, it should return a new docutils node tobe inserted in the document treein
placeofthe node node. Usuallythis node is a reference node containingcontnode as a child.
Parameters
• env – The build environment (app.builder.env).
• node – The pending_xref node to be resolved. Its attributes reftype,
reftarget, modname and classname attributes determine the type and target
of the reference.
• contnode – The node that carries the text and formatting inside the future refer-
ence and should bea child of the returned reference node.
New in version 0.5.
doctree-resolved(app,doctree, docname)
Emitted when a doctree has been “resolved” by the environment, that is, all references have been
resolved and TOCs have been inserted. Thedoctree can be modified in place.
Here is the place to replace custom nodes that don’t have visitor methods in the writers, so that they
don’t cause errors when the writers encounter them.
env-merge-info(env,docnames, other)
This eventis only emitted when parallel reading of documents isenabled. Itis emitted onceforevery
subprocess that has read some documents.
You must handle this event in an extension that stores data in the environment in a custom location.
Otherwise the environment in the main process will not be aware of the information stored in the
subprocess.
other is the environment object from the subprocess, env is the environment from the main process.
docnames is a set of document names thathave been read in the subprocess.
Fora sample of how to deal with this event,lookat the standard sphinx.ext.todo extension. The
implementation is often similar to that ofenv-purge-doc, only that information is not removed,
butadded to the main environment from theotherenvironment.
New in version 1.3.
env-updated(app,env)
Emitted when the update() method of the build environment has completed, that is, the environ-
ment and all doctreesare now up-to-date.
You can return an iterable of docnames from the handler. These documents will then be considered
updated,and will be(re-)written during the writingphase.
New in version 0.5.
Changed in version 1.3: Thehandlers’ return valueis now used.
html-collect-pages(app)
Emitted when theHTML builderis starting towrite non-documentpages. You canadd pages towrite
byreturningan iterablefrom this event consisting of (pagename, context, templatename).
New in version 1.0.
15.2. APIs used for writing extensions
167
C# Create PDF Library SDK to convert PDF from other file formats
Create fillable PDF document with fields. including ASP.NET web services and Windows Forms application. After creating a PDF document in C#.NET using this PDF
convert pdf to fillable form online; change pdf to fillable form
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
.net fill pdf form; convert pdf to fillable pdf form
Sphinx Documentation, Release 1.4.1
html-page-context(app,pagename, templatename,context,doctree)
Emitted when the HTML builder has created a contextdictionary to render atemplatewith – this can
beused to add custom elements to thecontext.
The pagename argument is the canonical name of the page being rendered, that is, without .html
suffix and using slashes as path separators. The templatename is the name of the template to render,
this will be ’page.html’ forall pages from reST documents.
Thecontext argumentisa dictionaryofvalues thataregiven tothe templateengine torenderthe page
and can be modified toinclude custom values. Keysmust be strings.
The doctree argument will be a doctree when the page is created from a reST documents; it will be
None when thepage is created from an HTML templatealone.
You can return a string from the handler, it will then replace ’page.html’ as the HTML template
forthis page.
New in version 0.4.
Changed in version 1.3: Thereturn value can now specify a template name.
build-finished(app,exception)
Emitted whenabuildhasfinished, beforeSphinx exits,usuallyused forcleanup. Thiseventisemitted
even when the build process raised an exception, given as the exception argument. The exception is
reraised in theapplication after theevent handlers have run. If thebuild process raised noexception,
exception will be None. This allows to customize cleanup actions depending on the exception status.
New in version 0.5.
Checking the Sphinx version
Use this toadaptyour extension to API changes in Sphinx.
sphinx.version_info
Atuple of five elements; forSphinx version 1.2.1beta3 this would be (1, 2, 1, ’beta’, 3).
New in version 1.2: Before version 1.2, checkthestring sphinx.__version__.
The Config object
class sphinx.config.Config
The configobject makes the values of all configvalues available asattributes.
It is available as the config attribute on the application and environment objects. For example, to
get thevalue oflanguage,use either app.config.language or env.config.language.
The template bridge
class sphinx.application.TemplateBridge
This class defines the interface fora “template bridge”, that is, a class that renders templates given a
template name and a context.
init(builder, theme=None, dirs=None)
Called by the builder to initializethe template system.
builder is the builder object; you’ll probably want to look at the value of
builder.config.templates_path.
168
Chapter 15. Developing extensions for Sphinx
VB.NET Create PDF Library SDK to convert PDF from other file
Batch create adobe PDF document from multiple forms in VB Best VB.NET component to convert Microsoft Office Word Create and save editable PDF with a blank page
create a pdf form to fill out; create a fillable pdf form from a pdf
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
create fill pdf form; converting pdf to fillable form
Sphinx Documentation, Release 1.4.1
theme is a sphinx.theming.Theme object or None; in the latter case, dirs can be list of fixed
directories to look for templates.
newest_template_mtime()
Called by the builder to determine if output files are outdated because of template changes.
Return the mtime of the newest template file that was changed. The default implementation
returns 0.
render(template,context)
Called by thebuildertorendera template given as a filename with a specified context(a Python
dictionary).
render_string(template,context)
Called by the builder to render a template given as a string with a specified context (a Python
dictionary).
Exceptions
exception sphinx.errors.SphinxError
This is the base class for “nice” exceptions. When such an exception is raised, Sphinx will abort the
build and presentthe exception category and message to theuser.
Extensions areencouraged to derivefrom this exception fortheir custom errors.
Exceptions not derived fromSphinxError are treated as unexpected and shown to the user with a
part of thetraceback (and the full traceback saved in a temporary file).
category
Description ofthe exception “category”, used in converting the exception to a string (“category:
message”). Should be set accordingly in subclasses.
exception sphinx.errors.ConfigError
Used forerroneous values or nonsensical combinations of configuration values.
exception sphinx.errors.ExtensionError
Used forerrors in setting up extensions.
exception sphinx.errors.ThemeError
Used forerrors todo with themes.
exception sphinx.errors.VersionRequirementError
Raised when the docs require a higherSphinx version than the current one.
15.2.3 Build environment API
class sphinx.environment.BuildEnvironment
Attributes
app
Reference to theSphinx (application) object.
config
Reference to theConfig object.
srcdir
Sourcedirectory.
confdir
Directorycontaining conf.py.
15.2. APIs used for writing extensions
169
Sphinx Documentation, Release 1.4.1
doctreedir
Directoryfor storingpickled doctrees.
found_docs
Aset of all existing docnames.
metadata
Dictionarymapping docnames to“metadata” (seeFile-widemetadata).
titles
Dictionarymapping docnames tothedocutils nodefor theirmain title.
docname
Returns the docname of thedocumentcurrentlybeingparsed.
Utilitymethods
warn(docname,msg,lineno=None, **kwargs)
Emit a warning.
This differs from using app.warn() in that the warning may not be emitted instantly, but col-
lected for emitting all warnings after theupdate of the environment.
warn_node(msg, node,**kwargs)
Likewarn(), but with source information taken from node.
doc2path(docname,base=True, suffix=None)
Return the filename forthe document name.
If base is True, return absolute path under self.srcdir. If base is None, return relative path to
self.srcdir. If base is a path string, return absolute path under that. If suffix is not None, add it
instead ofconfig.source_suffix.
relfn2path(filename,docname=None)
Return paths to a filereferenced from a document, relativetodocumentation root and absolute.
In the input “filename”, absolute filenames are taken as relative tothe source dir, while relative
filenames arerelative to thedir of the containingdocument.
note_dependency(filename)
Add filename as a dependencyof the current document.
This means that the documentwill berebuilt if this file changes.
filename should beabsolute or relativetothe sourcedirectory.
new_serialno(category=’‘)
Return a serial number,e.g. for index entry targets.
The number is guaranteed to be uniquein the current document.
note_reread()
Add the current document to the list of documents thatwill automaticallybere-read at the next
build.
15.2.4 Builder API
Todo
Expand this.
170
Chapter 15. Developing extensions for Sphinx
Sphinx Documentation, Release 1.4.1
class sphinx.builders.Builder
This is thebase class for all builders.
These methods are predefined and will be called from theapplication:
get_relative_uri(from_, to, typ=None)
Return a relative URI between twosource filenames.
Mayraiseenvironment.NoUri if there’sno way toreturn a sensible URI.
build_all()
Build all source files.
build_specific(filenames)
Only rebuild as much as needed for changes in the filenames.
build_update()
Only rebuild whatwas changed or added sincelast build.
build(docnames, summary=None, method=’update’)
Main build method.
Firstupdates theenvironment, and then calls write().
These methods can be overridden in concrete builderclasses:
init()
Load necessary templates and perform initialization. The default implementation does nothing.
get_outdated_docs()
Return an iterable of output files that are outdated, or a string describing what an update build
will build.
If the builder does not outputindividual files correspondingtosource files, return a string here.
If itdoes,return an iterableof those files thatneed tobewritten.
get_target_uri(docname, typ=None)
Return the targetURIfor a documentname.
typ can be used toqualifythe linkcharacteristic forindividual builders.
prepare_writing(docnames)
Aplace where you can add logic beforewrite_doc() is run
write_doc(docname,doctree)
Where you actuallywrite something to the filesystem.
finish()
Finish the buildingprocess.
The default implementation does nothing.
15.2.5 Docutils markup API
This section describes the API for adding ReST markup elements (roles and directives).
15.2. APIs used for writing extensions
171
Sphinx Documentation, Release 1.4.1
Roles
Directives
Directives
are
handled
by
classes
derived
from
docutils.parsers.rst.Directive.
They
have
to
be
registered
by
an
extension
using
Sphinx.add_directive()
or
Sphinx.add_directive_to_domain().
class docutils.parsers.rst.Directive
The markup syntax of the new directive is determined bythe follow fiveclass attributes:
required_arguments = 0
Numberofrequired directive arguments.
optional_arguments = 0
Numberofoptional arguments afterthe required arguments.
final_argument_whitespace = False
Maythe final argumentcontain whitespace?
option_spec = None
Mapping of option names to validator functions.
Option validator functions take a single parameter, the option argument (or None if not given),
and should validate it orconvert it to the proper form. They raise ValueError or TypeError
toindicatefailure.
There
are
several
predefined
and
possibly
useful
validators
in
the
docutils.parsers.rst.directives module.
has_content = False
Maythe directive havecontent?
New directives mustimplement therun() method:
run()
This method must process the directive arguments,options and content, and return a list of Do-
cutils/Sphinx nodes thatwill be inserted intothe document tree atthe pointwhere the directive
was encountered.
Instanceattributes that arealways set on the directiveare:
name
The directive name(useful when registering the same directiveclass under multiplenames).
arguments
The arguments given tothe directive, as alist.
options
Theoptionsgiven tothedirective,asa dictionarymappingoption namestovalidated/converted
values.
content
The directive content, if given, as a ViewList.
lineno
The absoluteline numberon whichthe directiveappeared. This is notalwaysa useful value;use
srclineinstead.
src
The sourcefile of the directive.
172
Chapter 15. Developing extensions for Sphinx
Sphinx Documentation, Release 1.4.1
srcline
The line number in the source file on which thedirective appeared.
content_offset
Internal offset of thedirective content. Used when calling nested_parse (see below).
block_text
The string containingthe entire directive.
state
state_machine
The state and state machinewhich controls the parsing. Used for nested_parse.
ViewLists
Docutils represents document source lines in a class docutils.statemachine.ViewList. This is a list
with extended functionality – for one, slicing creates views of the original list, and also the list contains
information aboutthe source line numbers.
TheDirective.content attribute is a ViewList. Ifyou generate content to be parsed as ReST, you have
to create a ViewListyourself. Important forcontent generation are thefollowingpoints:
• The constructor takesa listofstrings (lines) and a source(document) name.
• The .append() method takes a lineand a source nameas well.
Parsing directive content as ReST
Many directives will contain more markup that must be parsed. To do this, use one of the following APIs
from theDirective.run() method:
• self.state.nested_parse
• sphinx.util.nodes.nested_parse_with_titles() – this allows titles in the parsed content.
Both APIs parse thecontentinto a given node. They areused likethis:
node = docutils.nodes.paragraph()
# either
nested_parse_with_titles(self.state, self.result, node)
# or
self.state.nested_parse(self.result, 0, node)
If you don’t need the wrapping node, you can use any concrete node type and return node.children
from theDirective.
See also:
Creating directives178 HOWTOoftheDocutilsdocumentation
15.2.6 Domain API
class sphinx.domains.Domain(env)
ADomain is meant to be a group of “object” description directives for objects of a similar nature,
and corresponding roles to create references to them. Examples would be Python modules, classes,
functions etc., elements of a templating language, Sphinx roles and directives, etc.
178
http://docutils.sourceforge.net/docs/howto/rst-directives.html
15.2. APIs used for writing extensions
173
Sphinx Documentation, Release 1.4.1
Each domain has aseparate storage forinformation about existingobjectsand how toreference them
in self.data, which mustbea dictionary. Italsomustimplementseveral functions thatexpose theobject
information in a uniform way to parts of Sphinx that allow the user to reference or search for objects
in a domain-agnostic way.
About self.data: since all object and cross-referencing information is stored on a BuildEnvironment
instance, the domain.data object is also stored in the env.domaindata dict under the key domain.name.
Before the build process starts, every active domain is instantiated and given theenvironmentobject;
the domaindata dictmustthen eitherbenonexistent ora dictionary whose‘version’ key is equal to the
domain class’data_version attribute. Otherwise,IOError is raised and the pickled environment is
discarded.
clear_doc(docname)
Remove traces ofa document in the domain-specific inventories.
directive(name)
Return a directive adapter class that always gives the registered directive its full name (‘do-
main:name’) as self.name.
get_objects()
Return an iterableof“object descriptions”, which are tuples with five items:
•name – fullyqualified name
•dispname –nametodisplay when searching/linking
•type – object type, a key in self.object_types
•docname – the document where itis to be found
•anchor – the anchor namefor theobject
•priority – how “important” the objectis (determines placement in search results)
–1: default priority (placed beforefull-text matches)
–0: object is important (placed beforedefault-priority objects)
–2: object is unimportant (placed afterfull-textmatches)
–-1: object should not show up in search at all
get_type_name(type,primary=False)
Return full name for given ObjType.
merge_domaindata(docnames,otherdata)
Merge in data regarding docnames from a different domaindata inventory (coming from a sub-
process in parallel builds).
process_doc(env, docname, document)
Process a documentafter it is read bythe environment.
resolve_any_xref(env, fromdocname, builder,target,node,contnode)
Resolve thepending_xref node with the given target.
The reference comes from an “any” or similar role, which means that we don’t know the type.
Otherwise, the arguments arethe same as forresolve_xref().
The method must return a list (potentially empty) of tuples (’domain:role’, newnode),
where ’domain:role’ is the name of a role that could have created the same reference, e.g.
’py:func’. newnode is whatresolve_xref() would return.
New in version 1.3.
174
Chapter 15. Developing extensions for Sphinx
Documents you may be interested
Documents you may be interested