rubyXL 1.2.10 → 3.4.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.circleci/config.yml +60 -0
- data/.codeclimate.yml +3 -0
- data/.rubocop.yml +124 -0
- data/CHANGELOG.md +12 -0
- data/Gemfile +18 -14
- data/LICENSE.txt +1 -1
- data/README.rdoc +170 -100
- data/Rakefile +76 -26
- data/VERSION +1 -1
- data/lib/rubyXL/cell.rb +13 -447
- data/lib/rubyXL/convenience_methods/cell.rb +276 -0
- data/lib/rubyXL/convenience_methods/color.rb +156 -0
- data/lib/rubyXL/convenience_methods/font.rb +63 -0
- data/lib/rubyXL/convenience_methods/workbook.rb +137 -0
- data/lib/rubyXL/convenience_methods/worksheet.rb +734 -0
- data/lib/rubyXL/convenience_methods.rb +5 -0
- data/lib/rubyXL/objects/border.rb +71 -0
- data/lib/rubyXL/objects/calculation_chain.rb +31 -0
- data/lib/rubyXL/objects/cell_style.rb +63 -0
- data/lib/rubyXL/objects/chartsheet.rb +88 -0
- data/lib/rubyXL/objects/color.rb +25 -0
- data/lib/rubyXL/objects/column_range.rb +93 -0
- data/lib/rubyXL/objects/comments.rb +44 -0
- data/lib/rubyXL/objects/connection.rb +175 -0
- data/lib/rubyXL/objects/container_nodes.rb +131 -0
- data/lib/rubyXL/objects/content_types.rb +74 -0
- data/lib/rubyXL/objects/data_validation.rb +37 -0
- data/lib/rubyXL/objects/document_properties.rb +156 -0
- data/lib/rubyXL/objects/extensions.rb +51 -0
- data/lib/rubyXL/objects/external_links.rb +115 -0
- data/lib/rubyXL/objects/fill.rb +52 -0
- data/lib/rubyXL/objects/filters.rb +118 -0
- data/lib/rubyXL/objects/font.rb +43 -0
- data/lib/rubyXL/objects/formula.rb +22 -0
- data/lib/rubyXL/objects/ooxml_object.rb +469 -0
- data/lib/rubyXL/objects/query_table.rb +106 -0
- data/lib/rubyXL/objects/reference.rb +119 -0
- data/lib/rubyXL/objects/relationships.rb +213 -0
- data/lib/rubyXL/objects/root.rb +84 -0
- data/lib/rubyXL/objects/shared_strings.rb +67 -0
- data/lib/rubyXL/objects/sheet_common.rb +49 -0
- data/lib/rubyXL/objects/sheet_data.rb +219 -0
- data/lib/rubyXL/objects/simple_types.rb +249 -0
- data/lib/rubyXL/objects/storage.rb +193 -0
- data/lib/rubyXL/objects/stylesheet.rb +224 -0
- data/lib/rubyXL/objects/text.rb +92 -0
- data/lib/rubyXL/objects/theme.rb +1730 -0
- data/lib/rubyXL/objects/workbook.rb +572 -0
- data/lib/rubyXL/objects/worksheet.rb +762 -0
- data/lib/rubyXL/parser.rb +18 -459
- data/lib/rubyXL/worksheet.rb +73 -1461
- data/lib/rubyXL.rb +9 -7
- data/rdoc/README_rdoc.html +534 -0
- data/rdoc/RubyXL/AExtension.html +187 -0
- data/rdoc/RubyXL/AExtensionStorageArea.html +97 -0
- data/rdoc/RubyXL/ActiveX.html +156 -0
- data/rdoc/RubyXL/ActiveXBinary.html +106 -0
- data/rdoc/RubyXL/AdjustHandleList.html +99 -0
- data/rdoc/RubyXL/Alignment.html +99 -0
- data/rdoc/RubyXL/AlternateContent.html +97 -0
- data/rdoc/RubyXL/AlternateUrls.html +99 -0
- data/rdoc/RubyXL/Authors.html +99 -0
- data/rdoc/RubyXL/AutoFilter.html +99 -0
- data/rdoc/RubyXL/AutoFilterColumn.html +99 -0
- data/rdoc/RubyXL/BinaryImageFile.html +108 -0
- data/rdoc/RubyXL/BodyProperties.html +99 -0
- data/rdoc/RubyXL/BooleanNode.html +97 -0
- data/rdoc/RubyXL/BooleanValue.html +97 -0
- data/rdoc/RubyXL/Border.html +223 -0
- data/rdoc/RubyXL/BorderEdge.html +160 -0
- data/rdoc/RubyXL/Borders.html +138 -0
- data/rdoc/RubyXL/Break.html +99 -0
- data/rdoc/RubyXL/BreakList.html +99 -0
- data/rdoc/RubyXL/CT_AdjPoint2D.html +99 -0
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +99 -0
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +99 -0
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +99 -0
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +99 -0
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +99 -0
- data/rdoc/RubyXL/CT_Backdrop.html +99 -0
- data/rdoc/RubyXL/CT_Bevel.html +99 -0
- data/rdoc/RubyXL/CT_BiLevelEffect.html +99 -0
- data/rdoc/RubyXL/CT_BlendEffect.html +99 -0
- data/rdoc/RubyXL/CT_Blip.html +99 -0
- data/rdoc/RubyXL/CT_BlipFillProperties.html +99 -0
- data/rdoc/RubyXL/CT_BlurEffect.html +99 -0
- data/rdoc/RubyXL/CT_Camera.html +99 -0
- data/rdoc/RubyXL/CT_Color.html +99 -0
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +99 -0
- data/rdoc/RubyXL/CT_ColorMapping.html +99 -0
- data/rdoc/RubyXL/CT_ColorScheme.html +99 -0
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +99 -0
- data/rdoc/RubyXL/CT_ConnectionSite.html +99 -0
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +99 -0
- data/rdoc/RubyXL/CT_DashStop.html +99 -0
- data/rdoc/RubyXL/CT_DashStopList.html +99 -0
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +99 -0
- data/rdoc/RubyXL/CT_DuotoneEffect.html +99 -0
- data/rdoc/RubyXL/CT_EffectContainer.html +99 -0
- data/rdoc/RubyXL/CT_EffectList.html +99 -0
- data/rdoc/RubyXL/CT_EffectReference.html +99 -0
- data/rdoc/RubyXL/CT_EffectStyleItem.html +99 -0
- data/rdoc/RubyXL/CT_EffectStyleList.html +99 -0
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +99 -0
- data/rdoc/RubyXL/CT_FillEffect.html +99 -0
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +99 -0
- data/rdoc/RubyXL/CT_FillStyleList.html +99 -0
- data/rdoc/RubyXL/CT_FlatText.html +99 -0
- data/rdoc/RubyXL/CT_FontCollection.html +99 -0
- data/rdoc/RubyXL/CT_FontReference.html +99 -0
- data/rdoc/RubyXL/CT_GeomGuideList.html +99 -0
- data/rdoc/RubyXL/CT_GlowEffect.html +99 -0
- data/rdoc/RubyXL/CT_GradientFillProperties.html +99 -0
- data/rdoc/RubyXL/CT_GradientStop.html +99 -0
- data/rdoc/RubyXL/CT_GradientStopList.html +99 -0
- data/rdoc/RubyXL/CT_HSLEffect.html +99 -0
- data/rdoc/RubyXL/CT_HslColor.html +99 -0
- data/rdoc/RubyXL/CT_Hyperlink.html +99 -0
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +99 -0
- data/rdoc/RubyXL/CT_LightRig.html +99 -0
- data/rdoc/RubyXL/CT_LineEndProperties.html +99 -0
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +99 -0
- data/rdoc/RubyXL/CT_LineProperties.html +99 -0
- data/rdoc/RubyXL/CT_LineStyleList.html +99 -0
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +99 -0
- data/rdoc/RubyXL/CT_LuminanceEffect.html +99 -0
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +99 -0
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +99 -0
- data/rdoc/RubyXL/CT_Path2D.html +99 -0
- data/rdoc/RubyXL/CT_Path2DArcTo.html +99 -0
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +99 -0
- data/rdoc/RubyXL/CT_Path2DList.html +99 -0
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +99 -0
- data/rdoc/RubyXL/CT_Path2DTo.html +99 -0
- data/rdoc/RubyXL/CT_PathShadeProperties.html +99 -0
- data/rdoc/RubyXL/CT_PatternFillProperties.html +99 -0
- data/rdoc/RubyXL/CT_Point3D.html +99 -0
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +99 -0
- data/rdoc/RubyXL/CT_PresetColor.html +99 -0
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +99 -0
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +99 -0
- data/rdoc/RubyXL/CT_PresetTextShape.html +99 -0
- data/rdoc/RubyXL/CT_ReflectionEffect.html +99 -0
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +99 -0
- data/rdoc/RubyXL/CT_RelativeRect.html +99 -0
- data/rdoc/RubyXL/CT_SRgbColor.html +99 -0
- data/rdoc/RubyXL/CT_ScRgbColor.html +99 -0
- data/rdoc/RubyXL/CT_Scene3D.html +99 -0
- data/rdoc/RubyXL/CT_SchemeColor.html +99 -0
- data/rdoc/RubyXL/CT_Shape3D.html +99 -0
- data/rdoc/RubyXL/CT_ShapeStyle.html +99 -0
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +99 -0
- data/rdoc/RubyXL/CT_SphereCoords.html +99 -0
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +99 -0
- data/rdoc/RubyXL/CT_StyleMatrix.html +99 -0
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +99 -0
- data/rdoc/RubyXL/CT_SupplementalFont.html +99 -0
- data/rdoc/RubyXL/CT_SystemColor.html +99 -0
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +99 -0
- data/rdoc/RubyXL/CT_TextBlipBullet.html +99 -0
- data/rdoc/RubyXL/CT_TextCharBullet.html +99 -0
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +99 -0
- data/rdoc/RubyXL/CT_TextFont.html +99 -0
- data/rdoc/RubyXL/CT_TextListStyle.html +99 -0
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +99 -0
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +99 -0
- data/rdoc/RubyXL/CT_TextSpacing.html +99 -0
- data/rdoc/RubyXL/CT_TextTabStop.html +99 -0
- data/rdoc/RubyXL/CT_TextTabStopList.html +99 -0
- data/rdoc/RubyXL/CT_TileInfoProperties.html +99 -0
- data/rdoc/RubyXL/CT_TintEffect.html +99 -0
- data/rdoc/RubyXL/CT_Transform2D.html +99 -0
- data/rdoc/RubyXL/CT_TransformEffect.html +99 -0
- data/rdoc/RubyXL/CT_Vector3D.html +99 -0
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +99 -0
- data/rdoc/RubyXL/CalculationChain.html +149 -0
- data/rdoc/RubyXL/CalculationChainCell.html +99 -0
- data/rdoc/RubyXL/CalculationProperties.html +99 -0
- data/rdoc/RubyXL/Cell.html +510 -0
- data/rdoc/RubyXL/CellConvenienceMethods.html +1077 -0
- data/rdoc/RubyXL/CellExt.html +99 -0
- data/rdoc/RubyXL/CellSmartTag.html +99 -0
- data/rdoc/RubyXL/CellSmartTagProperty.html +99 -0
- data/rdoc/RubyXL/CellSmartTags.html +99 -0
- data/rdoc/RubyXL/CellStyle.html +99 -0
- data/rdoc/RubyXL/CellStyleXFs.html +138 -0
- data/rdoc/RubyXL/CellStyles.html +138 -0
- data/rdoc/RubyXL/CellValue.html +139 -0
- data/rdoc/RubyXL/CellWatch.html +99 -0
- data/rdoc/RubyXL/CellWatches.html +99 -0
- data/rdoc/RubyXL/CellXFs.html +139 -0
- data/rdoc/RubyXL/ChartColorsFile.html +108 -0
- data/rdoc/RubyXL/ChartFile.html +160 -0
- data/rdoc/RubyXL/ChartStyleFile.html +108 -0
- data/rdoc/RubyXL/ChartUserShapesFile.html +108 -0
- data/rdoc/RubyXL/Chartsheet.html +213 -0
- data/rdoc/RubyXL/ChartsheetPageSetup.html +99 -0
- data/rdoc/RubyXL/ChartsheetProperties.html +99 -0
- data/rdoc/RubyXL/ChartsheetProtection.html +99 -0
- data/rdoc/RubyXL/ChartsheetView.html +99 -0
- data/rdoc/RubyXL/ChartsheetViews.html +99 -0
- data/rdoc/RubyXL/Color.html +151 -0
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +246 -0
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +285 -0
- data/rdoc/RubyXL/ColorConvenienceClasses.html +91 -0
- data/rdoc/RubyXL/ColorConvenienceMethods.html +139 -0
- data/rdoc/RubyXL/ColorFilter.html +99 -0
- data/rdoc/RubyXL/ColorScale.html +99 -0
- data/rdoc/RubyXL/ColorSet.html +99 -0
- data/rdoc/RubyXL/Colors.html +99 -0
- data/rdoc/RubyXL/ColumnRange.html +230 -0
- data/rdoc/RubyXL/ColumnRanges.html +237 -0
- data/rdoc/RubyXL/Comment.html +99 -0
- data/rdoc/RubyXL/CommentList.html +99 -0
- data/rdoc/RubyXL/CommentsFile.html +165 -0
- data/rdoc/RubyXL/ConditionalFormatValue.html +99 -0
- data/rdoc/RubyXL/ConditionalFormatting.html +99 -0
- data/rdoc/RubyXL/ConditionalFormattingRule.html +99 -0
- data/rdoc/RubyXL/Connection.html +99 -0
- data/rdoc/RubyXL/ConnectionTable.html +99 -0
- data/rdoc/RubyXL/ConnectionTables.html +99 -0
- data/rdoc/RubyXL/ConnectionTextField.html +99 -0
- data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
- data/rdoc/RubyXL/Connections.html +149 -0
- data/rdoc/RubyXL/ContentTypeDefault.html +97 -0
- data/rdoc/RubyXL/ContentTypeOverride.html +97 -0
- data/rdoc/RubyXL/ContentTypes.html +211 -0
- data/rdoc/RubyXL/ControlPropertiesFile.html +108 -0
- data/rdoc/RubyXL/CorePropertiesFile.html +355 -0
- data/rdoc/RubyXL/CustomColor.html +99 -0
- data/rdoc/RubyXL/CustomColorList.html +99 -0
- data/rdoc/RubyXL/CustomFilter.html +99 -0
- data/rdoc/RubyXL/CustomFilters.html +99 -0
- data/rdoc/RubyXL/CustomGeometry.html +99 -0
- data/rdoc/RubyXL/CustomProperties.html +99 -0
- data/rdoc/RubyXL/CustomPropertiesFile.html +108 -0
- data/rdoc/RubyXL/CustomProperty.html +99 -0
- data/rdoc/RubyXL/CustomPropertyFile.html +108 -0
- data/rdoc/RubyXL/CustomSheetView.html +99 -0
- data/rdoc/RubyXL/CustomSheetViews.html +99 -0
- data/rdoc/RubyXL/CustomWorkbookView.html +99 -0
- data/rdoc/RubyXL/CustomWorkbookViews.html +99 -0
- data/rdoc/RubyXL/CustomXMLFile.html +106 -0
- data/rdoc/RubyXL/DXF.html +99 -0
- data/rdoc/RubyXL/DXFs.html +99 -0
- data/rdoc/RubyXL/DataBar.html +99 -0
- data/rdoc/RubyXL/DataConsolidate.html +99 -0
- data/rdoc/RubyXL/DataConsolidationReference.html +99 -0
- data/rdoc/RubyXL/DataConsolidationReferences.html +99 -0
- data/rdoc/RubyXL/DataType.html +114 -0
- data/rdoc/RubyXL/DataValidation.html +99 -0
- data/rdoc/RubyXL/DataValidations.html +99 -0
- data/rdoc/RubyXL/DateGroupItem.html +99 -0
- data/rdoc/RubyXL/DefinedName.html +99 -0
- data/rdoc/RubyXL/DefinedNameExt.html +99 -0
- data/rdoc/RubyXL/DefinedNames.html +99 -0
- data/rdoc/RubyXL/DefinedNamesExt.html +99 -0
- data/rdoc/RubyXL/DocumentPropertiesFile.html +213 -0
- data/rdoc/RubyXL/DrawingFile.html +159 -0
- data/rdoc/RubyXL/DynamicFilter.html +99 -0
- data/rdoc/RubyXL/EmbeddedControl.html +99 -0
- data/rdoc/RubyXL/EmbeddedControls.html +99 -0
- data/rdoc/RubyXL/Extension.html +99 -0
- data/rdoc/RubyXL/ExtensionStorageArea.html +99 -0
- data/rdoc/RubyXL/Extents.html +99 -0
- data/rdoc/RubyXL/ExternalBook.html +99 -0
- data/rdoc/RubyXL/ExternalLinksFile.html +155 -0
- data/rdoc/RubyXL/ExternalReference.html +99 -0
- data/rdoc/RubyXL/ExternalReferences.html +99 -0
- data/rdoc/RubyXL/ExtraColorSchemeList.html +99 -0
- data/rdoc/RubyXL/FieldItem.html +99 -0
- data/rdoc/RubyXL/FileRecoveryProperties.html +99 -0
- data/rdoc/RubyXL/FileSharing.html +99 -0
- data/rdoc/RubyXL/FileVersion.html +99 -0
- data/rdoc/RubyXL/Fill.html +138 -0
- data/rdoc/RubyXL/Fills.html +138 -0
- data/rdoc/RubyXL/FilterContainer.html +99 -0
- data/rdoc/RubyXL/FloatNode.html +97 -0
- data/rdoc/RubyXL/FloatValue.html +97 -0
- data/rdoc/RubyXL/Font.html +148 -0
- data/rdoc/RubyXL/FontConvenienceMethods.html +442 -0
- data/rdoc/RubyXL/FontScheme.html +99 -0
- data/rdoc/RubyXL/Fonts.html +138 -0
- data/rdoc/RubyXL/Formula.html +99 -0
- data/rdoc/RubyXL/FunctionGroup.html +99 -0
- data/rdoc/RubyXL/FunctionGroups.html +99 -0
- data/rdoc/RubyXL/GenericStorageObject.html +241 -0
- data/rdoc/RubyXL/GradientFill.html +99 -0
- data/rdoc/RubyXL/HeaderFooterSettings.html +99 -0
- data/rdoc/RubyXL/Hyperlink.html +99 -0
- data/rdoc/RubyXL/HyperlinkRelFile.html +106 -0
- data/rdoc/RubyXL/Hyperlinks.html +99 -0
- data/rdoc/RubyXL/IconFilter.html +99 -0
- data/rdoc/RubyXL/IconSet.html +99 -0
- data/rdoc/RubyXL/IgnoredError.html +99 -0
- data/rdoc/RubyXL/IgnoredErrors.html +99 -0
- data/rdoc/RubyXL/IndexedColors.html +99 -0
- data/rdoc/RubyXL/InputCells.html +99 -0
- data/rdoc/RubyXL/IntegerNode.html +97 -0
- data/rdoc/RubyXL/IntegerValue.html +97 -0
- data/rdoc/RubyXL/LegacyCell.html +130 -0
- data/rdoc/RubyXL/LegacyWorksheet.html +306 -0
- data/rdoc/RubyXL/MRUColors.html +99 -0
- data/rdoc/RubyXL/MacrosFile.html +108 -0
- data/rdoc/RubyXL/MergedCell.html +99 -0
- data/rdoc/RubyXL/MergedCells.html +99 -0
- data/rdoc/RubyXL/NumFmt.html +99 -0
- data/rdoc/RubyXL/NumberFormat.html +139 -0
- data/rdoc/RubyXL/NumberFormats.html +147 -0
- data/rdoc/RubyXL/OLEObject.html +99 -0
- data/rdoc/RubyXL/OLEObjectFile.html +108 -0
- data/rdoc/RubyXL/OLEObjects.html +99 -0
- data/rdoc/RubyXL/OLESize.html +99 -0
- data/rdoc/RubyXL/OOXMLContainerObject.html +309 -0
- data/rdoc/RubyXL/OOXMLIgnored.html +167 -0
- data/rdoc/RubyXL/OOXMLObject.html +107 -0
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +455 -0
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +442 -0
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +470 -0
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +297 -0
- data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
- data/rdoc/RubyXL/Offset.html +99 -0
- data/rdoc/RubyXL/OlapProperties.html +99 -0
- data/rdoc/RubyXL/OleItem.html +99 -0
- data/rdoc/RubyXL/OleItems.html +99 -0
- data/rdoc/RubyXL/OleLink.html +99 -0
- data/rdoc/RubyXL/OutlineProperties.html +99 -0
- data/rdoc/RubyXL/PageMargins.html +99 -0
- data/rdoc/RubyXL/PageSetup.html +99 -0
- data/rdoc/RubyXL/PageSetupProperties.html +99 -0
- data/rdoc/RubyXL/Pane.html +99 -0
- data/rdoc/RubyXL/Parser.html +174 -0
- data/rdoc/RubyXL/PatternFill.html +99 -0
- data/rdoc/RubyXL/PersonMetadata.html +108 -0
- data/rdoc/RubyXL/PhoneticProperties.html +99 -0
- data/rdoc/RubyXL/PhoneticRun.html +99 -0
- data/rdoc/RubyXL/PivotArea.html +99 -0
- data/rdoc/RubyXL/PivotCache.html +99 -0
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +116 -0
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +108 -0
- data/rdoc/RubyXL/PivotCaches.html +99 -0
- data/rdoc/RubyXL/PivotReference.html +99 -0
- data/rdoc/RubyXL/PivotReferences.html +99 -0
- data/rdoc/RubyXL/PivotTableFile.html +116 -0
- data/rdoc/RubyXL/PivotTableSelection.html +99 -0
- data/rdoc/RubyXL/PresetGeometry.html +99 -0
- data/rdoc/RubyXL/PrintOptions.html +99 -0
- data/rdoc/RubyXL/PrinterSettingsFile.html +108 -0
- data/rdoc/RubyXL/ProtectedRange.html +99 -0
- data/rdoc/RubyXL/ProtectedRanges.html +99 -0
- data/rdoc/RubyXL/Protection.html +99 -0
- data/rdoc/RubyXL/QueryParameter.html +99 -0
- data/rdoc/RubyXL/QueryParameters.html +99 -0
- data/rdoc/RubyXL/QueryTable.html +157 -0
- data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
- data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
- data/rdoc/RubyXL/QueryTableField.html +99 -0
- data/rdoc/RubyXL/QueryTableFields.html +99 -0
- data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
- data/rdoc/RubyXL/RID.html +97 -0
- data/rdoc/RubyXL/RawOOXML.html +187 -0
- data/rdoc/RubyXL/Reference.html +510 -0
- data/rdoc/RubyXL/Relationship.html +97 -0
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +131 -0
- data/rdoc/RubyXL/RelationshipSupport.html +336 -0
- data/rdoc/RubyXL/RevisionPointer.html +99 -0
- data/rdoc/RubyXL/RichText.html +141 -0
- data/rdoc/RubyXL/RichTextRun.html +138 -0
- data/rdoc/RubyXL/Row.html +357 -0
- data/rdoc/RubyXL/RowExt.html +99 -0
- data/rdoc/RubyXL/RunProperties.html +99 -0
- data/rdoc/RubyXL/Scenario.html +99 -0
- data/rdoc/RubyXL/Scenarios.html +99 -0
- data/rdoc/RubyXL/Selection.html +146 -0
- data/rdoc/RubyXL/ShapeGuide.html +99 -0
- data/rdoc/RubyXL/ShapeTextRectangle.html +99 -0
- data/rdoc/RubyXL/SharedStringsTable.html +328 -0
- data/rdoc/RubyXL/Sheet.html +99 -0
- data/rdoc/RubyXL/SheetCalculationProperties.html +99 -0
- data/rdoc/RubyXL/SheetData.html +162 -0
- data/rdoc/RubyXL/SheetDataExt.html +99 -0
- data/rdoc/RubyXL/SheetDataSet.html +99 -0
- data/rdoc/RubyXL/SheetMetadata.html +108 -0
- data/rdoc/RubyXL/SheetName.html +99 -0
- data/rdoc/RubyXL/SheetNames.html +99 -0
- data/rdoc/RubyXL/Sheets.html +99 -0
- data/rdoc/RubyXL/SlicerCacheFile.html +108 -0
- data/rdoc/RubyXL/SlicerFile.html +108 -0
- data/rdoc/RubyXL/SmartTagProperties.html +99 -0
- data/rdoc/RubyXL/SmartTagType.html +99 -0
- data/rdoc/RubyXL/SmartTagTypes.html +99 -0
- data/rdoc/RubyXL/SmartTags.html +99 -0
- data/rdoc/RubyXL/SortCondition.html +99 -0
- data/rdoc/RubyXL/SortState.html +99 -0
- data/rdoc/RubyXL/Sqref.html +167 -0
- data/rdoc/RubyXL/Stop.html +99 -0
- data/rdoc/RubyXL/StringNode.html +97 -0
- data/rdoc/RubyXL/StringNodeW3C.html +167 -0
- data/rdoc/RubyXL/StringValue.html +97 -0
- data/rdoc/RubyXL/Stylesheet.html +281 -0
- data/rdoc/RubyXL/TableFile.html +108 -0
- data/rdoc/RubyXL/TableParts.html +97 -0
- data/rdoc/RubyXL/TableStyle.html +99 -0
- data/rdoc/RubyXL/TableStyles.html +99 -0
- data/rdoc/RubyXL/Text.html +175 -0
- data/rdoc/RubyXL/TextImportSettings.html +99 -0
- data/rdoc/RubyXL/Theme.html +535 -0
- data/rdoc/RubyXL/ThemeElements.html +99 -0
- data/rdoc/RubyXL/ThumbnailFile.html +108 -0
- data/rdoc/RubyXL/Top10.html +99 -0
- data/rdoc/RubyXL/VMLDrawingFile.html +116 -0
- data/rdoc/RubyXL/Variant.html +99 -0
- data/rdoc/RubyXL/Vector.html +142 -0
- data/rdoc/RubyXL/VectorValue.html +97 -0
- data/rdoc/RubyXL/VisualProperties.html +99 -0
- data/rdoc/RubyXL/WebPublishObject.html +99 -0
- data/rdoc/RubyXL/WebPublishObjects.html +99 -0
- data/rdoc/RubyXL/WebPublishingItem.html +99 -0
- data/rdoc/RubyXL/WebPublishingItems.html +99 -0
- data/rdoc/RubyXL/WebPublishingProperties.html +99 -0
- data/rdoc/RubyXL/WebQueryProperties.html +99 -0
- data/rdoc/RubyXL/Workbook.html +948 -0
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +596 -0
- data/rdoc/RubyXL/WorkbookProperties.html +99 -0
- data/rdoc/RubyXL/WorkbookProtection.html +99 -0
- data/rdoc/RubyXL/WorkbookRoot.html +325 -0
- data/rdoc/RubyXL/WorkbookView.html +99 -0
- data/rdoc/RubyXL/WorkbookViews.html +99 -0
- data/rdoc/RubyXL/Worksheet.html +418 -0
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +2205 -0
- data/rdoc/RubyXL/WorksheetDimensions.html +99 -0
- data/rdoc/RubyXL/WorksheetFormatProperties.html +97 -0
- data/rdoc/RubyXL/WorksheetProperties.html +99 -0
- data/rdoc/RubyXL/WorksheetProtection.html +99 -0
- data/rdoc/RubyXL/WorksheetView.html +99 -0
- data/rdoc/RubyXL/WorksheetViews.html +99 -0
- data/rdoc/RubyXL/XF.html +99 -0
- data/rdoc/RubyXL.html +338 -0
- data/rdoc/created.rid +45 -0
- data/rdoc/css/fonts.css +167 -0
- data/rdoc/css/rdoc.css +687 -0
- data/rdoc/fonts/Lato-Light.ttf +0 -0
- data/rdoc/fonts/Lato-LightItalic.ttf +0 -0
- data/rdoc/fonts/Lato-Regular.ttf +0 -0
- data/rdoc/fonts/Lato-RegularItalic.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/images/add.png +0 -0
- data/rdoc/images/arrow_up.png +0 -0
- data/rdoc/images/brick.png +0 -0
- data/rdoc/images/brick_link.png +0 -0
- data/rdoc/images/bug.png +0 -0
- data/rdoc/images/bullet_black.png +0 -0
- data/rdoc/images/bullet_toggle_minus.png +0 -0
- data/rdoc/images/bullet_toggle_plus.png +0 -0
- data/rdoc/images/date.png +0 -0
- data/rdoc/images/delete.png +0 -0
- data/rdoc/images/find.png +0 -0
- data/rdoc/images/loadingAnimation.gif +0 -0
- data/rdoc/images/macFFBgHack.png +0 -0
- data/rdoc/images/package.png +0 -0
- data/rdoc/images/page_green.png +0 -0
- data/rdoc/images/page_white_text.png +0 -0
- data/rdoc/images/page_white_width.png +0 -0
- data/rdoc/images/plugin.png +0 -0
- data/rdoc/images/ruby.png +0 -0
- data/rdoc/images/tag_blue.png +0 -0
- data/rdoc/images/tag_green.png +0 -0
- data/rdoc/images/transparent.png +0 -0
- data/rdoc/images/wrench.png +0 -0
- data/rdoc/images/wrench_orange.png +0 -0
- data/rdoc/images/zoom.png +0 -0
- data/rdoc/index.html +477 -0
- data/rdoc/js/darkfish.js +97 -0
- data/rdoc/js/navigation.js +105 -0
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search.js +110 -0
- data/rdoc/js/search_index.js +1 -0
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +229 -0
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +3021 -0
- data/rubyXL.gemspec +521 -60
- data/spec/lib/cell_spec.rb +386 -143
- data/spec/lib/color_spec.rb +11 -4
- data/spec/lib/parser_spec.rb +90 -38
- data/spec/lib/reference_spec.rb +64 -0
- data/spec/lib/rgb_color_spec.rb +29 -0
- data/spec/lib/stylesheet_spec.rb +27 -0
- data/spec/lib/text_spec.rb +27 -0
- data/spec/lib/workbook_spec.rb +168 -22
- data/spec/lib/worksheet_spec.rb +1207 -1220
- data/spec/spec_helper.rb +13 -0
- data/test/input/.gitkeep +0 -0
- data/test/output/.gitkeep +0 -0
- data/test/test_parse_write.rb +15 -0
- data/tmp/.gitignore +1 -0
- metadata +634 -168
- data/Gemfile.lock +0 -34
- data/lib/.DS_Store +0 -0
- data/lib/rubyXL/Hash.rb +0 -60
- data/lib/rubyXL/color.rb +0 -14
- data/lib/rubyXL/private_class.rb +0 -265
- data/lib/rubyXL/workbook.rb +0 -450
- data/lib/rubyXL/writer/app_writer.rb +0 -62
- data/lib/rubyXL/writer/calc_chain_writer.rb +0 -33
- data/lib/rubyXL/writer/content_types_writer.rb +0 -77
- data/lib/rubyXL/writer/core_writer.rb +0 -51
- data/lib/rubyXL/writer/root_rels_writer.rb +0 -25
- data/lib/rubyXL/writer/shared_strings_writer.rb +0 -30
- data/lib/rubyXL/writer/styles_writer.rb +0 -407
- data/lib/rubyXL/writer/theme_writer.rb +0 -343
- data/lib/rubyXL/writer/workbook_rels_writer.rb +0 -59
- data/lib/rubyXL/writer/workbook_writer.rb +0 -77
- data/lib/rubyXL/writer/worksheet_writer.rb +0 -230
- data/lib/rubyXL/zip.rb +0 -20
- data/spec/lib/hash_spec.rb +0 -28
|
@@ -0,0 +1,1077 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>module RubyXL::CellConvenienceMethods - rubyXL 3.4.33</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="module">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
<!-- Method Quickref -->
|
|
65
|
+
<div id="method-list-section" class="nav-section">
|
|
66
|
+
<h3>Methods</h3>
|
|
67
|
+
|
|
68
|
+
<ul class="link-list" role="directory">
|
|
69
|
+
<li ><a href="#method-i-add_hyperlink">#add_hyperlink</a>
|
|
70
|
+
<li ><a href="#method-i-change_border">#change_border</a>
|
|
71
|
+
<li ><a href="#method-i-change_border_color">#change_border_color</a>
|
|
72
|
+
<li ><a href="#method-i-change_contents">#change_contents</a>
|
|
73
|
+
<li ><a href="#method-i-change_fill">#change_fill</a>
|
|
74
|
+
<li ><a href="#method-i-change_font_bold">#change_font_bold</a>
|
|
75
|
+
<li ><a href="#method-i-change_font_color">#change_font_color</a>
|
|
76
|
+
<li ><a href="#method-i-change_font_italics">#change_font_italics</a>
|
|
77
|
+
<li ><a href="#method-i-change_font_name">#change_font_name</a>
|
|
78
|
+
<li ><a href="#method-i-change_font_size">#change_font_size</a>
|
|
79
|
+
<li ><a href="#method-i-change_font_strikethrough">#change_font_strikethrough</a>
|
|
80
|
+
<li ><a href="#method-i-change_font_underline">#change_font_underline</a>
|
|
81
|
+
<li ><a href="#method-i-change_horizontal_alignment">#change_horizontal_alignment</a>
|
|
82
|
+
<li ><a href="#method-i-change_shrink_to_fit">#change_shrink_to_fit</a>
|
|
83
|
+
<li ><a href="#method-i-change_text_indent">#change_text_indent</a>
|
|
84
|
+
<li ><a href="#method-i-change_text_rotation">#change_text_rotation</a>
|
|
85
|
+
<li ><a href="#method-i-change_text_wrap">#change_text_wrap</a>
|
|
86
|
+
<li ><a href="#method-i-change_vertical_alignment">#change_vertical_alignment</a>
|
|
87
|
+
<li ><a href="#method-i-fill_color">#fill_color</a>
|
|
88
|
+
<li ><a href="#method-i-font_color">#font_color</a>
|
|
89
|
+
<li ><a href="#method-i-font_name">#font_name</a>
|
|
90
|
+
<li ><a href="#method-i-font_size">#font_size</a>
|
|
91
|
+
<li ><a href="#method-i-font_switch">#font_switch</a>
|
|
92
|
+
<li ><a href="#method-i-get_border">#get_border</a>
|
|
93
|
+
<li ><a href="#method-i-get_border_color">#get_border_color</a>
|
|
94
|
+
<li ><a href="#method-i-horizontal_alignment">#horizontal_alignment</a>
|
|
95
|
+
<li ><a href="#method-i-is_bolded">#is_bolded</a>
|
|
96
|
+
<li ><a href="#method-i-is_italicized">#is_italicized</a>
|
|
97
|
+
<li ><a href="#method-i-is_struckthrough">#is_struckthrough</a>
|
|
98
|
+
<li ><a href="#method-i-is_underlined">#is_underlined</a>
|
|
99
|
+
<li ><a href="#method-i-remove_formula">#remove_formula</a>
|
|
100
|
+
<li ><a href="#method-i-set_number_format">#set_number_format</a>
|
|
101
|
+
<li ><a href="#method-i-text_indent">#text_indent</a>
|
|
102
|
+
<li ><a href="#method-i-text_rotation">#text_rotation</a>
|
|
103
|
+
<li ><a href="#method-i-text_wrap">#text_wrap</a>
|
|
104
|
+
<li ><a href="#method-i-vertical_alignment">#vertical_alignment</a>
|
|
105
|
+
</ul>
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</nav>
|
|
110
|
+
|
|
111
|
+
<main role="main" aria-labelledby="module-RubyXL::CellConvenienceMethods">
|
|
112
|
+
<h1 id="module-RubyXL::CellConvenienceMethods" class="module">
|
|
113
|
+
module RubyXL::CellConvenienceMethods
|
|
114
|
+
</h1>
|
|
115
|
+
|
|
116
|
+
<section class="description">
|
|
117
|
+
|
|
118
|
+
</section>
|
|
119
|
+
|
|
120
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
127
|
+
<header>
|
|
128
|
+
<h3>Public Instance Methods</h3>
|
|
129
|
+
</header>
|
|
130
|
+
|
|
131
|
+
<div id="method-i-add_hyperlink" class="method-detail ">
|
|
132
|
+
<div class="method-header">
|
|
133
|
+
<div class="method-heading">
|
|
134
|
+
<span class="method-name">add_hyperlink</span><span
|
|
135
|
+
class="method-args">(url, tooltip = nil)</span>
|
|
136
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
137
|
+
</div>
|
|
138
|
+
</div>
|
|
139
|
+
|
|
140
|
+
<div class="method-description">
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<div class="method-source-code" id="add_hyperlink-source">
|
|
144
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 256</span>
|
|
145
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_hyperlink</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">tooltip</span> = <span class="ruby-keyword">nil</span>)
|
|
146
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">relationship_container</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLRelationshipsFile</span>.<span class="ruby-identifier">new</span>
|
|
147
|
+
<span class="ruby-identifier">relationships</span> = <span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">relationship_container</span>.<span class="ruby-identifier">relationships</span>
|
|
148
|
+
<span class="ruby-identifier">r_id</span> = <span class="ruby-node">"rId#{relationships.size + 1}"</span>
|
|
149
|
+
<span class="ruby-identifier">relationships</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Relationship</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:id</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">r_id</span>, <span class="ruby-value">:target</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">url</span>, <span class="ruby-value">:target_mode</span> <span class="ruby-operator">=></span> <span class="ruby-string">'External'</span>,
|
|
150
|
+
<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">HyperlinkRelFile</span><span class="ruby-operator">::</span><span class="ruby-constant">REL_TYPE</span>)
|
|
151
|
+
|
|
152
|
+
<span class="ruby-identifier">hyperlink</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlink</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:ref</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">r</span>, <span class="ruby-value">:r_id</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">r_id</span>)
|
|
153
|
+
<span class="ruby-identifier">hyperlink</span>.<span class="ruby-identifier">tooltip</span> = <span class="ruby-identifier">tooltip</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">tooltip</span>
|
|
154
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">hyperlinks</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlinks</span>.<span class="ruby-identifier">new</span>
|
|
155
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">hyperlinks</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">hyperlink</span>
|
|
156
|
+
<span class="ruby-keyword">end</span></pre>
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
<div id="method-i-change_border" class="method-detail ">
|
|
164
|
+
<div class="method-header">
|
|
165
|
+
<div class="method-heading">
|
|
166
|
+
<span class="method-name">change_border</span><span
|
|
167
|
+
class="method-args">(direction, weight)</span>
|
|
168
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
169
|
+
</div>
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
<div class="method-description">
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<div class="method-source-code" id="change_border-source">
|
|
176
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 71</span>
|
|
177
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_border</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>)
|
|
178
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
179
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_border</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>)
|
|
180
|
+
<span class="ruby-keyword">end</span></pre>
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
<div id="method-i-change_border_color" class="method-detail ">
|
|
188
|
+
<div class="method-header">
|
|
189
|
+
<div class="method-heading">
|
|
190
|
+
<span class="method-name">change_border_color</span><span
|
|
191
|
+
class="method-args">(direction, color)</span>
|
|
192
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
193
|
+
</div>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
<div class="method-description">
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<div class="method-source-code" id="change_border_color-source">
|
|
200
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 76</span>
|
|
201
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_border_color</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">color</span>)
|
|
202
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
203
|
+
<span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">color</span>)
|
|
204
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_border_color</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">color</span>)
|
|
205
|
+
<span class="ruby-keyword">end</span></pre>
|
|
206
|
+
</div>
|
|
207
|
+
</div>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="method-i-change_contents" class="method-detail ">
|
|
213
|
+
<div class="method-header">
|
|
214
|
+
<div class="method-heading">
|
|
215
|
+
<span class="method-name">change_contents</span><span
|
|
216
|
+
class="method-args">(data, formula_expression = nil)</span>
|
|
217
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
218
|
+
</div>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
<div class="method-description">
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div class="method-source-code" id="change_contents-source">
|
|
225
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 3</span>
|
|
226
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_contents</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">formula_expression</span> = <span class="ruby-keyword">nil</span>)
|
|
227
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
228
|
+
|
|
229
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">formula_expression</span> <span class="ruby-keyword">then</span>
|
|
230
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">datatype</span> = <span class="ruby-keyword">nil</span>
|
|
231
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">formula</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Formula</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:expression</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">formula_expression</span>)
|
|
232
|
+
<span class="ruby-keyword">else</span>
|
|
233
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">datatype</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">data</span>
|
|
234
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Date</span>, <span class="ruby-constant">Time</span>, <span class="ruby-constant">Numeric</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">nil</span>
|
|
235
|
+
<span class="ruby-keyword">else</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">DataType</span><span class="ruby-operator">::</span><span class="ruby-constant">RAW_STRING</span>
|
|
236
|
+
<span class="ruby-keyword">end</span>
|
|
237
|
+
<span class="ruby-keyword">end</span>
|
|
238
|
+
|
|
239
|
+
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">date_to_num</span>(<span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Time</span>)
|
|
240
|
+
|
|
241
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">raw_value</span> = <span class="ruby-identifier">data</span>
|
|
242
|
+
<span class="ruby-keyword">end</span></pre>
|
|
243
|
+
</div>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
<div id="method-i-change_fill" class="method-detail ">
|
|
250
|
+
<div class="method-header">
|
|
251
|
+
<div class="method-heading">
|
|
252
|
+
<span class="method-name">change_fill</span><span
|
|
253
|
+
class="method-args">(rgb = 'ffffff')</span>
|
|
254
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
255
|
+
</div>
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
<div class="method-description">
|
|
259
|
+
<p>Changes fill color of cell</p>
|
|
260
|
+
|
|
261
|
+
<div class="method-source-code" id="change_fill-source">
|
|
262
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 165</span>
|
|
263
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_fill</span>(<span class="ruby-identifier">rgb</span> = <span class="ruby-string">'ffffff'</span>)
|
|
264
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
265
|
+
<span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">rgb</span>)
|
|
266
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_fill</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">rgb</span>)
|
|
267
|
+
<span class="ruby-keyword">end</span></pre>
|
|
268
|
+
</div>
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
<div id="method-i-change_font_bold" class="method-detail ">
|
|
275
|
+
<div class="method-header">
|
|
276
|
+
<div class="method-heading">
|
|
277
|
+
<span class="method-name">change_font_bold</span><span
|
|
278
|
+
class="method-args">(bolded = false)</span>
|
|
279
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
280
|
+
</div>
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
<div class="method-description">
|
|
284
|
+
<p>Changes font bold settings of cell</p>
|
|
285
|
+
|
|
286
|
+
<div class="method-source-code" id="change_font_bold-source">
|
|
287
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 210</span>
|
|
288
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_bold</span>(<span class="ruby-identifier">bolded</span> = <span class="ruby-keyword">false</span>)
|
|
289
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
290
|
+
|
|
291
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
292
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_bold</span>(<span class="ruby-identifier">bolded</span>)
|
|
293
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
294
|
+
<span class="ruby-keyword">end</span></pre>
|
|
295
|
+
</div>
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
<div id="method-i-change_font_color" class="method-detail ">
|
|
302
|
+
<div class="method-header">
|
|
303
|
+
<div class="method-heading">
|
|
304
|
+
<span class="method-name">change_font_color</span><span
|
|
305
|
+
class="method-args">(font_color = '000000')</span>
|
|
306
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
307
|
+
</div>
|
|
308
|
+
</div>
|
|
309
|
+
|
|
310
|
+
<div class="method-description">
|
|
311
|
+
<p>Changes font color of cell</p>
|
|
312
|
+
|
|
313
|
+
<div class="method-source-code" id="change_font_color-source">
|
|
314
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 191</span>
|
|
315
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_color</span>(<span class="ruby-identifier">font_color</span> = <span class="ruby-string">'000000'</span>)
|
|
316
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
317
|
+
<span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">font_color</span>)
|
|
318
|
+
|
|
319
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
320
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_rgb_color</span>(<span class="ruby-identifier">font_color</span>)
|
|
321
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
322
|
+
<span class="ruby-keyword">end</span></pre>
|
|
323
|
+
</div>
|
|
324
|
+
</div>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
<div id="method-i-change_font_italics" class="method-detail ">
|
|
330
|
+
<div class="method-header">
|
|
331
|
+
<div class="method-heading">
|
|
332
|
+
<span class="method-name">change_font_italics</span><span
|
|
333
|
+
class="method-args">(italicized = false)</span>
|
|
334
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
335
|
+
</div>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
<div class="method-description">
|
|
339
|
+
<p>Changes font italics settings of cell</p>
|
|
340
|
+
|
|
341
|
+
<div class="method-source-code" id="change_font_italics-source">
|
|
342
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 201</span>
|
|
343
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_italics</span>(<span class="ruby-identifier">italicized</span> = <span class="ruby-keyword">false</span>)
|
|
344
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
345
|
+
|
|
346
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
347
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_italic</span>(<span class="ruby-identifier">italicized</span>)
|
|
348
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
349
|
+
<span class="ruby-keyword">end</span></pre>
|
|
350
|
+
</div>
|
|
351
|
+
</div>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
</div>
|
|
355
|
+
|
|
356
|
+
<div id="method-i-change_font_name" class="method-detail ">
|
|
357
|
+
<div class="method-header">
|
|
358
|
+
<div class="method-heading">
|
|
359
|
+
<span class="method-name">change_font_name</span><span
|
|
360
|
+
class="method-args">(new_font_name = 'Verdana')</span>
|
|
361
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
362
|
+
</div>
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
<div class="method-description">
|
|
366
|
+
<p>Changes font name of cell</p>
|
|
367
|
+
|
|
368
|
+
<div class="method-source-code" id="change_font_name-source">
|
|
369
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 172</span>
|
|
370
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_name</span>(<span class="ruby-identifier">new_font_name</span> = <span class="ruby-string">'Verdana'</span>)
|
|
371
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
372
|
+
|
|
373
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
374
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_name</span>(<span class="ruby-identifier">new_font_name</span>)
|
|
375
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
376
|
+
<span class="ruby-keyword">end</span></pre>
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
<div id="method-i-change_font_size" class="method-detail ">
|
|
384
|
+
<div class="method-header">
|
|
385
|
+
<div class="method-heading">
|
|
386
|
+
<span class="method-name">change_font_size</span><span
|
|
387
|
+
class="method-args">(font_size = 10)</span>
|
|
388
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
389
|
+
</div>
|
|
390
|
+
</div>
|
|
391
|
+
|
|
392
|
+
<div class="method-description">
|
|
393
|
+
<p>Changes font size of cell</p>
|
|
394
|
+
|
|
395
|
+
<div class="method-source-code" id="change_font_size-source">
|
|
396
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 181</span>
|
|
397
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_size</span>(<span class="ruby-identifier">font_size</span> = <span class="ruby-value">10</span>)
|
|
398
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
399
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Argument must be a number'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">font_size</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">font_size</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Float</span>)
|
|
400
|
+
|
|
401
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
402
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_size</span>(<span class="ruby-identifier">font_size</span>)
|
|
403
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
404
|
+
<span class="ruby-keyword">end</span></pre>
|
|
405
|
+
</div>
|
|
406
|
+
</div>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
<div id="method-i-change_font_strikethrough" class="method-detail ">
|
|
412
|
+
<div class="method-header">
|
|
413
|
+
<div class="method-heading">
|
|
414
|
+
<span class="method-name">change_font_strikethrough</span><span
|
|
415
|
+
class="method-args">(struckthrough = false)</span>
|
|
416
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
417
|
+
</div>
|
|
418
|
+
</div>
|
|
419
|
+
|
|
420
|
+
<div class="method-description">
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<div class="method-source-code" id="change_font_strikethrough-source">
|
|
424
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 227</span>
|
|
425
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_strikethrough</span>(<span class="ruby-identifier">struckthrough</span> = <span class="ruby-keyword">false</span>)
|
|
426
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
427
|
+
|
|
428
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
429
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_strikethrough</span>(<span class="ruby-identifier">struckthrough</span>)
|
|
430
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
431
|
+
<span class="ruby-keyword">end</span></pre>
|
|
432
|
+
</div>
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
</div>
|
|
437
|
+
|
|
438
|
+
<div id="method-i-change_font_underline" class="method-detail ">
|
|
439
|
+
<div class="method-header">
|
|
440
|
+
<div class="method-heading">
|
|
441
|
+
<span class="method-name">change_font_underline</span><span
|
|
442
|
+
class="method-args">(underlined = false)</span>
|
|
443
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
444
|
+
</div>
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
<div class="method-description">
|
|
448
|
+
<p>Changes font underline settings of cell</p>
|
|
449
|
+
|
|
450
|
+
<div class="method-source-code" id="change_font_underline-source">
|
|
451
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 219</span>
|
|
452
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_font_underline</span>(<span class="ruby-identifier">underlined</span> = <span class="ruby-keyword">false</span>)
|
|
453
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
454
|
+
|
|
455
|
+
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
|
|
456
|
+
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_underline</span>(<span class="ruby-identifier">underlined</span>)
|
|
457
|
+
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
|
|
458
|
+
<span class="ruby-keyword">end</span></pre>
|
|
459
|
+
</div>
|
|
460
|
+
</div>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
</div>
|
|
464
|
+
|
|
465
|
+
<div id="method-i-change_horizontal_alignment" class="method-detail ">
|
|
466
|
+
<div class="method-header">
|
|
467
|
+
<div class="method-heading">
|
|
468
|
+
<span class="method-name">change_horizontal_alignment</span><span
|
|
469
|
+
class="method-args">(alignment = 'center')</span>
|
|
470
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
471
|
+
</div>
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
<div class="method-description">
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<div class="method-source-code" id="change_horizontal_alignment-source">
|
|
478
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 41</span>
|
|
479
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_horizontal_alignment</span>(<span class="ruby-identifier">alignment</span> = <span class="ruby-string">'center'</span>)
|
|
480
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
481
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">horizontal</span> = <span class="ruby-identifier">alignment</span> }
|
|
482
|
+
<span class="ruby-keyword">end</span></pre>
|
|
483
|
+
</div>
|
|
484
|
+
</div>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
</div>
|
|
488
|
+
|
|
489
|
+
<div id="method-i-change_shrink_to_fit" class="method-detail ">
|
|
490
|
+
<div class="method-header">
|
|
491
|
+
<div class="method-heading">
|
|
492
|
+
<span class="method-name">change_shrink_to_fit</span><span
|
|
493
|
+
class="method-args">(shrink_to_fit = false)</span>
|
|
494
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
495
|
+
</div>
|
|
496
|
+
</div>
|
|
497
|
+
|
|
498
|
+
<div class="method-description">
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<div class="method-source-code" id="change_shrink_to_fit-source">
|
|
502
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 56</span>
|
|
503
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_shrink_to_fit</span>(<span class="ruby-identifier">shrink_to_fit</span> = <span class="ruby-keyword">false</span>)
|
|
504
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
505
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">shrink_to_fit</span> = <span class="ruby-identifier">shrink_to_fit</span> }
|
|
506
|
+
<span class="ruby-keyword">end</span></pre>
|
|
507
|
+
</div>
|
|
508
|
+
</div>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
<div id="method-i-change_text_indent" class="method-detail ">
|
|
514
|
+
<div class="method-header">
|
|
515
|
+
<div class="method-heading">
|
|
516
|
+
<span class="method-name">change_text_indent</span><span
|
|
517
|
+
class="method-args">(indent)</span>
|
|
518
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
519
|
+
</div>
|
|
520
|
+
</div>
|
|
521
|
+
|
|
522
|
+
<div class="method-description">
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div class="method-source-code" id="change_text_indent-source">
|
|
526
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 66</span>
|
|
527
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_text_indent</span>(<span class="ruby-identifier">indent</span>)
|
|
528
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
529
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">indent</span> = <span class="ruby-identifier">indent</span> }
|
|
530
|
+
<span class="ruby-keyword">end</span></pre>
|
|
531
|
+
</div>
|
|
532
|
+
</div>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
<div id="method-i-change_text_rotation" class="method-detail ">
|
|
538
|
+
<div class="method-header">
|
|
539
|
+
<div class="method-heading">
|
|
540
|
+
<span class="method-name">change_text_rotation</span><span
|
|
541
|
+
class="method-args">(rot)</span>
|
|
542
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
543
|
+
</div>
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
<div class="method-description">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="method-source-code" id="change_text_rotation-source">
|
|
550
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 61</span>
|
|
551
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_text_rotation</span>(<span class="ruby-identifier">rot</span>)
|
|
552
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
553
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">text_rotation</span> = <span class="ruby-identifier">rot</span> }
|
|
554
|
+
<span class="ruby-keyword">end</span></pre>
|
|
555
|
+
</div>
|
|
556
|
+
</div>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
<div id="method-i-change_text_wrap" class="method-detail ">
|
|
562
|
+
<div class="method-header">
|
|
563
|
+
<div class="method-heading">
|
|
564
|
+
<span class="method-name">change_text_wrap</span><span
|
|
565
|
+
class="method-args">(wrap = false)</span>
|
|
566
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
567
|
+
</div>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
<div class="method-description">
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<div class="method-source-code" id="change_text_wrap-source">
|
|
574
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 51</span>
|
|
575
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_text_wrap</span>(<span class="ruby-identifier">wrap</span> = <span class="ruby-keyword">false</span>)
|
|
576
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
577
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">wrap_text</span> = <span class="ruby-identifier">wrap</span> }
|
|
578
|
+
<span class="ruby-keyword">end</span></pre>
|
|
579
|
+
</div>
|
|
580
|
+
</div>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</div>
|
|
584
|
+
|
|
585
|
+
<div id="method-i-change_vertical_alignment" class="method-detail ">
|
|
586
|
+
<div class="method-header">
|
|
587
|
+
<div class="method-heading">
|
|
588
|
+
<span class="method-name">change_vertical_alignment</span><span
|
|
589
|
+
class="method-args">(alignment = 'center')</span>
|
|
590
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
591
|
+
</div>
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
<div class="method-description">
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<div class="method-source-code" id="change_vertical_alignment-source">
|
|
598
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 46</span>
|
|
599
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_vertical_alignment</span>(<span class="ruby-identifier">alignment</span> = <span class="ruby-string">'center'</span>)
|
|
600
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
601
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">vertical</span> = <span class="ruby-identifier">alignment</span> }
|
|
602
|
+
<span class="ruby-keyword">end</span></pre>
|
|
603
|
+
</div>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</div>
|
|
608
|
+
|
|
609
|
+
<div id="method-i-fill_color" class="method-detail ">
|
|
610
|
+
<div class="method-header">
|
|
611
|
+
<div class="method-heading">
|
|
612
|
+
<span class="method-name">fill_color</span><span
|
|
613
|
+
class="method-args">()</span>
|
|
614
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
615
|
+
</div>
|
|
616
|
+
</div>
|
|
617
|
+
|
|
618
|
+
<div class="method-description">
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
<div class="method-source-code" id="fill_color-source">
|
|
622
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 117</span>
|
|
623
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fill_color</span>
|
|
624
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
625
|
+
<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">get_fill_color</span>(<span class="ruby-identifier">get_cell_xf</span>)
|
|
626
|
+
<span class="ruby-keyword">end</span></pre>
|
|
627
|
+
</div>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
<div id="method-i-font_color" class="method-detail ">
|
|
634
|
+
<div class="method-header">
|
|
635
|
+
<div class="method-heading">
|
|
636
|
+
<span class="method-name">font_color</span><span
|
|
637
|
+
class="method-args">()</span>
|
|
638
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
639
|
+
</div>
|
|
640
|
+
</div>
|
|
641
|
+
|
|
642
|
+
<div class="method-description">
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<div class="method-source-code" id="font_color-source">
|
|
646
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 112</span>
|
|
647
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">font_color</span>
|
|
648
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
649
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_rgb_color</span> <span class="ruby-operator">||</span> <span class="ruby-string">'000000'</span>
|
|
650
|
+
<span class="ruby-keyword">end</span></pre>
|
|
651
|
+
</div>
|
|
652
|
+
</div>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</div>
|
|
656
|
+
|
|
657
|
+
<div id="method-i-font_name" class="method-detail ">
|
|
658
|
+
<div class="method-header">
|
|
659
|
+
<div class="method-heading">
|
|
660
|
+
<span class="method-name">font_name</span><span
|
|
661
|
+
class="method-args">()</span>
|
|
662
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
663
|
+
</div>
|
|
664
|
+
</div>
|
|
665
|
+
|
|
666
|
+
<div class="method-description">
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
<div class="method-source-code" id="font_name-source">
|
|
670
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 102</span>
|
|
671
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">font_name</span>
|
|
672
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
673
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_name</span>
|
|
674
|
+
<span class="ruby-keyword">end</span></pre>
|
|
675
|
+
</div>
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
<div id="method-i-font_size" class="method-detail ">
|
|
682
|
+
<div class="method-header">
|
|
683
|
+
<div class="method-heading">
|
|
684
|
+
<span class="method-name">font_size</span><span
|
|
685
|
+
class="method-args">()</span>
|
|
686
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
687
|
+
</div>
|
|
688
|
+
</div>
|
|
689
|
+
|
|
690
|
+
<div class="method-description">
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
<div class="method-source-code" id="font_size-source">
|
|
694
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 107</span>
|
|
695
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">font_size</span>
|
|
696
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
697
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_size</span>
|
|
698
|
+
<span class="ruby-keyword">end</span></pre>
|
|
699
|
+
</div>
|
|
700
|
+
</div>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</div>
|
|
704
|
+
|
|
705
|
+
<div id="method-i-font_switch" class="method-detail ">
|
|
706
|
+
<div class="method-header">
|
|
707
|
+
<div class="method-heading">
|
|
708
|
+
<span class="method-name">font_switch</span><span
|
|
709
|
+
class="method-args">(change_type, arg)</span>
|
|
710
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
711
|
+
</div>
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
<div class="method-description">
|
|
715
|
+
<p>Performs correct modification based on what type of change_type is specified</p>
|
|
716
|
+
|
|
717
|
+
<div class="method-source-code" id="font_switch-source">
|
|
718
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 243</span>
|
|
719
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">font_switch</span>(<span class="ruby-identifier">change_type</span>, <span class="ruby-identifier">arg</span>)
|
|
720
|
+
<span class="ruby-keyword">case</span> <span class="ruby-identifier">change_type</span>
|
|
721
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">NAME</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_name</span>(<span class="ruby-identifier">arg</span>)
|
|
722
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">SIZE</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_size</span>(<span class="ruby-identifier">arg</span>)
|
|
723
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">COLOR</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_color</span>(<span class="ruby-identifier">arg</span>)
|
|
724
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">ITALICS</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_italics</span>(<span class="ruby-identifier">arg</span>)
|
|
725
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">BOLD</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_bold</span>(<span class="ruby-identifier">arg</span>)
|
|
726
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">UNDERLINE</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_underline</span>(<span class="ruby-identifier">arg</span>)
|
|
727
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">STRIKETHROUGH</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_strikethrough</span>(<span class="ruby-identifier">arg</span>)
|
|
728
|
+
<span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">'Invalid change_type'</span>
|
|
729
|
+
<span class="ruby-keyword">end</span>
|
|
730
|
+
<span class="ruby-keyword">end</span></pre>
|
|
731
|
+
</div>
|
|
732
|
+
</div>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
</div>
|
|
736
|
+
|
|
737
|
+
<div id="method-i-get_border" class="method-detail ">
|
|
738
|
+
<div class="method-header">
|
|
739
|
+
<div class="method-heading">
|
|
740
|
+
<span class="method-name">get_border</span><span
|
|
741
|
+
class="method-args">(direction)</span>
|
|
742
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
743
|
+
</div>
|
|
744
|
+
</div>
|
|
745
|
+
|
|
746
|
+
<div class="method-description">
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<div class="method-source-code" id="get_border-source">
|
|
750
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 31</span>
|
|
751
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_border</span>(<span class="ruby-identifier">direction</span>)
|
|
752
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
753
|
+
<span class="ruby-identifier">get_cell_border</span>.<span class="ruby-identifier">get_edge_style</span>(<span class="ruby-identifier">direction</span>)
|
|
754
|
+
<span class="ruby-keyword">end</span></pre>
|
|
755
|
+
</div>
|
|
756
|
+
</div>
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
</div>
|
|
760
|
+
|
|
761
|
+
<div id="method-i-get_border_color" class="method-detail ">
|
|
762
|
+
<div class="method-header">
|
|
763
|
+
<div class="method-heading">
|
|
764
|
+
<span class="method-name">get_border_color</span><span
|
|
765
|
+
class="method-args">(direction)</span>
|
|
766
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
767
|
+
</div>
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
<div class="method-description">
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
<div class="method-source-code" id="get_border_color-source">
|
|
774
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 36</span>
|
|
775
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_border_color</span>(<span class="ruby-identifier">direction</span>)
|
|
776
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
777
|
+
<span class="ruby-identifier">get_cell_border</span>.<span class="ruby-identifier">get_edge_color</span>(<span class="ruby-identifier">direction</span>)
|
|
778
|
+
<span class="ruby-keyword">end</span></pre>
|
|
779
|
+
</div>
|
|
780
|
+
</div>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</div>
|
|
784
|
+
|
|
785
|
+
<div id="method-i-horizontal_alignment" class="method-detail ">
|
|
786
|
+
<div class="method-header">
|
|
787
|
+
<div class="method-heading">
|
|
788
|
+
<span class="method-name">horizontal_alignment</span><span
|
|
789
|
+
class="method-args">()</span>
|
|
790
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
791
|
+
</div>
|
|
792
|
+
</div>
|
|
793
|
+
|
|
794
|
+
<div class="method-description">
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
<div class="method-source-code" id="horizontal_alignment-source">
|
|
798
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 122</span>
|
|
799
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">horizontal_alignment</span>
|
|
800
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
801
|
+
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
|
|
802
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
|
|
803
|
+
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">horizontal</span>
|
|
804
|
+
<span class="ruby-keyword">end</span></pre>
|
|
805
|
+
</div>
|
|
806
|
+
</div>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
</div>
|
|
810
|
+
|
|
811
|
+
<div id="method-i-is_bolded" class="method-detail ">
|
|
812
|
+
<div class="method-header">
|
|
813
|
+
<div class="method-heading">
|
|
814
|
+
<span class="method-name">is_bolded</span><span
|
|
815
|
+
class="method-args">()</span>
|
|
816
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
817
|
+
</div>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
<div class="method-description">
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
<div class="method-source-code" id="is_bolded-source">
|
|
824
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 87</span>
|
|
825
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">is_bolded</span>
|
|
826
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
827
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_bold</span>
|
|
828
|
+
<span class="ruby-keyword">end</span></pre>
|
|
829
|
+
</div>
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
<div id="method-i-is_italicized" class="method-detail ">
|
|
836
|
+
<div class="method-header">
|
|
837
|
+
<div class="method-heading">
|
|
838
|
+
<span class="method-name">is_italicized</span><span
|
|
839
|
+
class="method-args">()</span>
|
|
840
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
841
|
+
</div>
|
|
842
|
+
</div>
|
|
843
|
+
|
|
844
|
+
<div class="method-description">
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
<div class="method-source-code" id="is_italicized-source">
|
|
848
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 82</span>
|
|
849
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">is_italicized</span>
|
|
850
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
851
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_italic</span>
|
|
852
|
+
<span class="ruby-keyword">end</span></pre>
|
|
853
|
+
</div>
|
|
854
|
+
</div>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
</div>
|
|
858
|
+
|
|
859
|
+
<div id="method-i-is_struckthrough" class="method-detail ">
|
|
860
|
+
<div class="method-header">
|
|
861
|
+
<div class="method-heading">
|
|
862
|
+
<span class="method-name">is_struckthrough</span><span
|
|
863
|
+
class="method-args">()</span>
|
|
864
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
865
|
+
</div>
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
<div class="method-description">
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
<div class="method-source-code" id="is_struckthrough-source">
|
|
872
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 97</span>
|
|
873
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">is_struckthrough</span>
|
|
874
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
875
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_strikethrough</span>
|
|
876
|
+
<span class="ruby-keyword">end</span></pre>
|
|
877
|
+
</div>
|
|
878
|
+
</div>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</div>
|
|
882
|
+
|
|
883
|
+
<div id="method-i-is_underlined" class="method-detail ">
|
|
884
|
+
<div class="method-header">
|
|
885
|
+
<div class="method-heading">
|
|
886
|
+
<span class="method-name">is_underlined</span><span
|
|
887
|
+
class="method-args">()</span>
|
|
888
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
889
|
+
</div>
|
|
890
|
+
</div>
|
|
891
|
+
|
|
892
|
+
<div class="method-description">
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<div class="method-source-code" id="is_underlined-source">
|
|
896
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 92</span>
|
|
897
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">is_underlined</span>
|
|
898
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
899
|
+
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_underlined</span>
|
|
900
|
+
<span class="ruby-keyword">end</span></pre>
|
|
901
|
+
</div>
|
|
902
|
+
</div>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
<div id="method-i-remove_formula" class="method-detail ">
|
|
908
|
+
<div class="method-header">
|
|
909
|
+
<div class="method-heading">
|
|
910
|
+
<span class="method-name">remove_formula</span><span
|
|
911
|
+
class="method-args">()</span>
|
|
912
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
913
|
+
</div>
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
<div class="method-description">
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
<div class="method-source-code" id="remove_formula-source">
|
|
920
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 21</span>
|
|
921
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_formula</span>
|
|
922
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">formula</span> = <span class="ruby-keyword">nil</span>
|
|
923
|
+
|
|
924
|
+
<span class="ruby-identifier">calculation_chain</span> = <span class="ruby-identifier">workbook</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">calculation_chain</span>
|
|
925
|
+
<span class="ruby-identifier">calculation_cells</span> = <span class="ruby-identifier">calculation_chain</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">calculation_chain</span>.<span class="ruby-identifier">cells</span>
|
|
926
|
+
<span class="ruby-identifier">calculation_cells</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">calculation_cells</span>.<span class="ruby-identifier">reject!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
|
927
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">ref</span>.<span class="ruby-identifier">col_range</span>.<span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">column</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">ref</span>.<span class="ruby-identifier">row_range</span>.<span class="ruby-identifier">begin</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">row</span>
|
|
928
|
+
}
|
|
929
|
+
<span class="ruby-keyword">end</span></pre>
|
|
930
|
+
</div>
|
|
931
|
+
</div>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
</div>
|
|
935
|
+
|
|
936
|
+
<div id="method-i-set_number_format" class="method-detail ">
|
|
937
|
+
<div class="method-header">
|
|
938
|
+
<div class="method-heading">
|
|
939
|
+
<span class="method-name">set_number_format</span><span
|
|
940
|
+
class="method-args">(format_code)</span>
|
|
941
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
942
|
+
</div>
|
|
943
|
+
</div>
|
|
944
|
+
|
|
945
|
+
<div class="method-description">
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
<div class="method-source-code" id="set_number_format-source">
|
|
949
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 157</span>
|
|
950
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_number_format</span>(<span class="ruby-identifier">format_code</span>)
|
|
951
|
+
<span class="ruby-identifier">new_xf</span> = <span class="ruby-identifier">get_cell_xf</span>.<span class="ruby-identifier">dup</span>
|
|
952
|
+
<span class="ruby-identifier">new_xf</span>.<span class="ruby-identifier">num_fmt_id</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">stylesheet</span>.<span class="ruby-identifier">register_number_format</span>(<span class="ruby-identifier">format_code</span>)
|
|
953
|
+
<span class="ruby-identifier">new_xf</span>.<span class="ruby-identifier">apply_number_format</span> = <span class="ruby-keyword">true</span>
|
|
954
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">register_new_xf</span>(<span class="ruby-identifier">new_xf</span>)
|
|
955
|
+
<span class="ruby-keyword">end</span></pre>
|
|
956
|
+
</div>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
<div id="method-i-text_indent" class="method-detail ">
|
|
963
|
+
<div class="method-header">
|
|
964
|
+
<div class="method-heading">
|
|
965
|
+
<span class="method-name">text_indent</span><span
|
|
966
|
+
class="method-args">()</span>
|
|
967
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
968
|
+
</div>
|
|
969
|
+
</div>
|
|
970
|
+
|
|
971
|
+
<div class="method-description">
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
<div class="method-source-code" id="text_indent-source">
|
|
975
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 150</span>
|
|
976
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">text_indent</span>
|
|
977
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
978
|
+
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
|
|
979
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
|
|
980
|
+
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">indent</span>
|
|
981
|
+
<span class="ruby-keyword">end</span></pre>
|
|
982
|
+
</div>
|
|
983
|
+
</div>
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
</div>
|
|
987
|
+
|
|
988
|
+
<div id="method-i-text_rotation" class="method-detail ">
|
|
989
|
+
<div class="method-header">
|
|
990
|
+
<div class="method-heading">
|
|
991
|
+
<span class="method-name">text_rotation</span><span
|
|
992
|
+
class="method-args">()</span>
|
|
993
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
994
|
+
</div>
|
|
995
|
+
</div>
|
|
996
|
+
|
|
997
|
+
<div class="method-description">
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
<div class="method-source-code" id="text_rotation-source">
|
|
1001
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 143</span>
|
|
1002
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">text_rotation</span>
|
|
1003
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
1004
|
+
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
|
|
1005
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
|
|
1006
|
+
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">text_rotation</span>
|
|
1007
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1008
|
+
</div>
|
|
1009
|
+
</div>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
</div>
|
|
1013
|
+
|
|
1014
|
+
<div id="method-i-text_wrap" class="method-detail ">
|
|
1015
|
+
<div class="method-header">
|
|
1016
|
+
<div class="method-heading">
|
|
1017
|
+
<span class="method-name">text_wrap</span><span
|
|
1018
|
+
class="method-args">()</span>
|
|
1019
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1020
|
+
</div>
|
|
1021
|
+
</div>
|
|
1022
|
+
|
|
1023
|
+
<div class="method-description">
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<div class="method-source-code" id="text_wrap-source">
|
|
1027
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 136</span>
|
|
1028
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">text_wrap</span>
|
|
1029
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
1030
|
+
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
|
|
1031
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
|
|
1032
|
+
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">wrap_text</span>
|
|
1033
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1034
|
+
</div>
|
|
1035
|
+
</div>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
</div>
|
|
1039
|
+
|
|
1040
|
+
<div id="method-i-vertical_alignment" class="method-detail ">
|
|
1041
|
+
<div class="method-header">
|
|
1042
|
+
<div class="method-heading">
|
|
1043
|
+
<span class="method-name">vertical_alignment</span><span
|
|
1044
|
+
class="method-args">()</span>
|
|
1045
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1046
|
+
</div>
|
|
1047
|
+
</div>
|
|
1048
|
+
|
|
1049
|
+
<div class="method-description">
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<div class="method-source-code" id="vertical_alignment-source">
|
|
1053
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods/cell.rb, line 129</span>
|
|
1054
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">vertical_alignment</span>
|
|
1055
|
+
<span class="ruby-identifier">validate_worksheet</span>
|
|
1056
|
+
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
|
|
1057
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
|
|
1058
|
+
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">vertical</span>
|
|
1059
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1060
|
+
</div>
|
|
1061
|
+
</div>
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
</div>
|
|
1065
|
+
|
|
1066
|
+
</section>
|
|
1067
|
+
|
|
1068
|
+
</section>
|
|
1069
|
+
</main>
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
<footer id="validator-badges" role="contentinfo">
|
|
1073
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
1074
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
|
|
1075
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
1076
|
+
</footer>
|
|
1077
|
+
|