Document Solutions for PDF
DS.Documents.Imaging Assembly / GrapeCity.Documents.Svg Namespace / GcSvgGraphics Class
Properties Methods

In This Topic
    GcSvgGraphics Class Members
    In This Topic

    The following tables list the members exposed by GcSvgGraphics.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the GcSvgGraphics class.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the current blend mode. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets the description of the SVG document.  
    Public PropertyGets a value indicating whether this instance of GrapeCity.Documents.Drawing.GcGraphics has been disposed and cannot be used anymore. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets a value indicating if strings and GrapeCity.Documents.Text.TextLayout objects are rendered using the graphic primitives instead of the specialized text drawing services. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets a value indicating whether fonts used in 'text' elements should be embedded.

    Changing this property only affects subsequent calls to GrapeCity.Documents.Drawing.GcGraphics.DrawTextLayout, GrapeCity.Documents.Drawing.GcGraphics.DrawString and GrapeCity.Documents.Drawing.GcGraphics.DrawString methods. Already rendered text is not affected.

    This property is ignored if GrapeCity.Documents.Drawing.GcGraphics.DrawTextAsPath is true.

    The default is false.

     
    Public PropertyGets or sets a GrapeCity.Documents.Text.FontCollection used by MeasureString and DrawString methods. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets the height of the image, in device-independent pixels (1/96ths of an inch).  
    Public PropertyGets or sets a string to be appended to the auto-generated ID values.  
    Public PropertyGets or sets a hint to the implementation about how to make speed vs. quality tradeoffs as it performs image processing.

    Setting this property affects the subsequent calls of the DrawImage methods. It does not affect the previous calls.

    The default is SvgImageRendering.Auto.  
    Public PropertyGets or sets the sampling mode to use when drawing images with resizing. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets a value indicating whether the images drawn with DrawImage methods should be disposed when disposing the resulting GcSvgDocument.

    Setting this property affects the subsequent calls of the DrawImage methods. It does not affect the previous calls.

    The default is false.  
    Public PropertyGets or sets a value indicating whether the positions are set for each individual character within the 'text' element.

    Setting this property to true makes the resulting SVG file larger but provides more precise positioning of individual characters.

    Changing this property only affects subsequent calls to GrapeCity.Documents.Drawing.GcGraphics.DrawTextLayout, GrapeCity.Documents.Drawing.GcGraphics.DrawString and GrapeCity.Documents.Drawing.GcGraphics.DrawString methods. Already rendered text is not affected.

    This property is ignored if GrapeCity.Documents.Drawing.GcGraphics.DrawTextAsPath is true.

    The default is false.

     
    Public PropertyOverridden. Gets the resolution of the current graphics, which is always 96 DPI for GcSvgGraphics.  
    Public PropertyGets or sets a hint to the implementation about what tradeoffs to make as it renders vector graphics elements.

    Setting this property affects the subsequent calls of the Draw/Fill methods. It does not affect the previous calls.

    The default is SvgShapeRendering.Auto.  
    Public PropertyGets the resolution of the underlying drawing surface (pixels per inch). (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public PropertyGets or sets the title of the SVG document.  
    Public PropertyOverridden. Gets or sets the transformation matrix of the current graphics.  
    Public PropertyGets or sets the width of the image, in device-independent pixels (1/96ths of an inch).  
    Top
    Public Methods
     NameDescription
    Public MethodApplies a license key to the current instance of GcSvgGraphics.

    A license key is required to use the ToSvgDocument method.

     
    Public MethodOverloaded. Creates a clip region from a graphics path.

    Use PushClip(IClipRegion) and PopClip to set/remove clipping.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodCreates a graphics path. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodCreates GrapeCity.Documents.Drawing.IPath object representing round border. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodCreates an instance of GrapeCity.Documents.Text.TextLayout with the same resolution as that of the current graphics.

    This is the recommended way to create a TextLayout to use with a graphics.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodDisposes the current graphics. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws an ellipse using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the ellipse is drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws an image using specified bounds, clipping and image alignment. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a line between two points, using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the line is drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a series of connected lines, using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the lines are drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a path using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the path is drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a polygon specified by an array of points, using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the polygon is drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a rectangle using a specified line color, width and style.

    If the value of lineStyle parameter is not GrapeCity.Documents.Drawing.DashStyle.Solid, the rectangle is drawn with a GrapeCity.Documents.Drawing.Pen having GrapeCity.Documents.Drawing.Pen.LineCap set to GrapeCity.Documents.Drawing.PenLineCap.Square instead of GrapeCity.Documents.Drawing.PenLineCap.Flat.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodDraws rotated text inside an unrotated rectangle.

    Note that the original textLayout will be changed by this method. If necessary, create a clone in advance.

    Also note that the values of the following properties are ignored: GrapeCity.Documents.Text.TextLayout.MaxWidth, GrapeCity.Documents.Text.TextLayout.MaxHeight, GrapeCity.Documents.Text.TextLayout.FlowDirection, GrapeCity.Documents.Text.TextLayout.CanSkipFirstLineWithIndentation, GrapeCity.Documents.Text.TextLayout.ObjectRects, GrapeCity.Documents.Text.TextLayout.ParagraphAlignment, GrapeCity.Documents.Text.TextLayout.MarginLeft, GrapeCity.Documents.Text.TextLayout.MarginRight, GrapeCity.Documents.Text.TextLayout.MarginTop, GrapeCity.Documents.Text.TextLayout.MarginBottom, GrapeCity.Documents.Text.TextLayout.ColumnWidth, GrapeCity.Documents.Text.TextLayout.RowHeight.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a rounded border defined by four GrapeCity.Documents.Drawing.Pen objects and GrapeCity.Documents.Drawing.CornerRadius structure. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodDraws rotated text inside a slanted rectangle.

    Note that the original textLayout will be changed by this method. If necessary, create a clone in advance.

    Also note that the values of the following properties are ignored: GrapeCity.Documents.Text.TextLayout.MaxWidth, GrapeCity.Documents.Text.TextLayout.MaxHeight, GrapeCity.Documents.Text.TextLayout.FlowDirection, GrapeCity.Documents.Text.TextLayout.CanSkipFirstLineWithIndentation, GrapeCity.Documents.Text.TextLayout.ObjectRects, GrapeCity.Documents.Text.TextLayout.ParagraphAlignment, GrapeCity.Documents.Text.TextLayout.MarginLeft, GrapeCity.Documents.Text.TextLayout.MarginRight, GrapeCity.Documents.Text.TextLayout.MarginTop, GrapeCity.Documents.Text.TextLayout.MarginBottom, GrapeCity.Documents.Text.TextLayout.ColumnWidth, GrapeCity.Documents.Text.TextLayout.RowHeight.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a string using a specified GrapeCity.Documents.Text.TextFormat at a specified location. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws a specified SVG document at a point specifying the position of the SVG viewport.

    To specify the position of the SVG content rather than viewport, see DrawSvgContent(GcSvgDocument,PointF,Single).

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Draws the content of a specified SVG document at a point specifying the top-left corner of the SVG content.

    To specify the position of the SVG viewport rather than content, see DrawSvg(GcSvgDocument,PointF,Single).

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodDraws a GrapeCity.Documents.Text.TextLayout at a specified location.

    If any part of the text does not fit in the layout bounds, it is truncated.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Fills an ellipse with a specified brush. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Fills a path using a specified brush. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Fills a polygon specified by an array of points, using a specified color and fill mode. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Fills a rectangle using a specified brush. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Fills a rounded rectangle using a specified brush. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodReturns the size of an image in pixels using the resolution of the current graphics. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodIndicates whether this graphics implementation supports a specified blend mode. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverridden. Indicates whether this graphics implementation supports a specified interpolation mode.

    The following interpolation modes are supported by GcSvgGraphics:

     
    Public MethodMeasures how an image will be drawn using the specified bounds and image alignment. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodCalculates the bounds of rotated text inside an unrotated rectangle.

    Note that the original textLayout will be changed by this method. If necessary, create a clone in advance.

    Also note that the values of the following properties are ignored: GrapeCity.Documents.Text.TextLayout.MaxWidth, GrapeCity.Documents.Text.TextLayout.MaxHeight, GrapeCity.Documents.Text.TextLayout.FlowDirection, GrapeCity.Documents.Text.TextLayout.CanSkipFirstLineWithIndentation, GrapeCity.Documents.Text.TextLayout.ObjectRects, GrapeCity.Documents.Text.TextLayout.ParagraphAlignment, GrapeCity.Documents.Text.TextLayout.MarginLeft, GrapeCity.Documents.Text.TextLayout.MarginRight, GrapeCity.Documents.Text.TextLayout.MarginTop, GrapeCity.Documents.Text.TextLayout.MarginBottom, GrapeCity.Documents.Text.TextLayout.ColumnWidth, GrapeCity.Documents.Text.TextLayout.RowHeight.

    (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Measures a string using a specified GrapeCity.Documents.Text.TextFormat, available layout size and GrapeCity.Documents.Text.TextSplitOptions. Also calculates and returns in an output parameter the number of chars that fit into the specified size. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodOverloaded. Measures a string using a specified font, font size and layout width, taking into account the trailing whitespace at the end of each line. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodCalculates the content bounds of a specified SVG document when its viewport is drawn at a specified point. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodRemoves the last clip. After this method is called, the clip is no longer applied to subsequent drawing operations. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodEnds the group that was created by the last PushGroup call.  
    Public MethodOverridden. Stops redirecting drawing operations to the transparency layer that was created by the last PushTransparencyLayer call.  
    Public MethodOverloaded. Specifies a rectangle to which all subsequent drawing operations are clipped. Clipping is applied only if containerRect does not contain clipRect.

    The GrapeCity.Documents.Drawing.GcGraphics.Clip object returned by this method implements IDisposable, so this method can be used with the 'using' pattern:

    using (g.PushClip(...)) ... in which case the clipping region will be removed when the returned object is disposed. (Inherited from GrapeCity.Documents.Drawing.GcGraphics)
    Public MethodStarts a group ('g') element with custom attributes in the SVG document. Call the PopGroup method to end the group.  
    Public MethodOverridden. Adds a transparency layer to the GcSvgGraphics so that it receives all subsequent drawing operations until PopTransparencyLayer is called.  
    Public Methodstatic (Shared in Visual Basic)Sets the license key.

    A license key is required to use the ToSvgDocument method.

     
    Public MethodGenerates a GcSvgDocument from this graphics, and clears its command list afterwards.

    Note that if a license key has not been applied (see SetLicenseKey and ApplyLicenseKey methods), only a few calls of ToSvgDocument() are allowed, after which an exception will be thrown.

     
    Top
    See Also